Function: createAssetsClient()

function createAssetsClient(config): object;

Defined in: src/assets/createAssetsClient.ts:134

Parameters

Parameter	Type
`config`	`AssetsClientConfig`

Returns

object

connectedTickets

connectedTickets: object;

connectedTickets.findObjectTickets

findObjectTickets: (parameters, options?) => Promise<{
[key: string]: unknown;
  allTicketsQuery: string;
  tickets?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `objectId`: `string`; }	-
`parameters.objectId`	`string`	The id of the object to get connected tickets for
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; allTicketsQuery: string; tickets?: object[]; }>

globalConfig

globalConfig: object;

globalConfig.updateGlobalConfiguration

updateGlobalConfiguration: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `allowOtherObjectSchema?`: `boolean`; `id`: `string`; `quickCreateObjects?`: `boolean`; `validateQuickCreate?`: `boolean`; }	-
`parameters.allowOtherObjectSchema?`	`boolean`	-
`parameters.id?`	`string`	Object schema id
`parameters.quickCreateObjects?`	`boolean`	-
`parameters.validateQuickCreate?`	`boolean`	-
`options?`	`RequestOptions`	-

Returns

Promise<void>

icons

icons: object;

icons.findGlobalIcons

findGlobalIcons: (options?) => Promise<object[]>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<object[]>

icons.getIcon

getIcon: (parameters, options?) => Promise<{
[key: string]: unknown;
  id: string;
  name: string;
  url16: string;
  url48: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `id`: `string`; }
`parameters.id`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; id: string; name: string; url16: string; url48: string; }>

icons.getIconImage

getIconImage: (parameters, options?) => Promise<ArrayBuffer | ArrayBufferView<ArrayBufferLike>>;

Parameters

Parameter	Type
`parameters`	{ `id`: `string`; `size?`: `number`; }
`parameters.id`	`string`
`parameters.size?`	`number`
`options?`	`RequestOptions`

Returns

Promise<ArrayBuffer | ArrayBufferView<ArrayBufferLike>>

imports

imports: object;

imports.startImport

startImport: (parameters, options?) => Promise<{
[key: string]: unknown;
  actor?: string;
  category?: string;
  currentStep?: number;
  currentStepTotalWorkUnits?: number;
  currentWorkDescription?: string;
  currentWorkUnits?: number;
  estimatedFinishDate?: Date;
  executionUUID?: string;
  finishedDate?: Date;
  numberOfSteps?: number;
  progressInPercent?: number;
  resourceId?: string;
  result?: string;
  resultData?: Record<string, any>;
  resultMessage?: string;
  startDate?: Date;
  status?: string;
  stepDescription?: string;
  totalWorkUnits?: number;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The id of the import configuration that should be started
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; actor?: string; category?: string; currentStep?: number; currentStepTotalWorkUnits?: number; currentWorkDescription?: string; currentWorkUnits?: number; estimatedFinishDate?: Date; executionUUID?: string; finishedDate?: Date; numberOfSteps?: number; progressInPercent?: number; resourceId?: string; result?: string; resultData?: Record<string, any>; resultMessage?: string; startDate?: Date; status?: string; stepDescription?: string; totalWorkUnits?: number; }>

importSources

importSources: object;

importSources.cancelImportExecution

cancelImportExecution: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `importExecutionId`: `string`; `importSourceId`: `string`; }	-
`parameters.importExecutionId`	`string`	The importExecutionId of the import
`parameters.importSourceId?`	`string`	The importSourceId of the import source configuration for the external import
`options?`	`RequestOptions`	-

Returns

Promise<void>

importSources.createFailedImportHistory

createFailedImportHistory: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `body?`: `Record`<`string`, `any`>; `executionId`: `string`; `importSourceId`: `string`; }	-
`parameters.body?`	`Record`<`string`, `any`>	-
`parameters.executionId?`	`string`	The executionId of the import execution
`parameters.importSourceId?`	`string`	The importSourceId of the import source configuration for the external import
`options?`	`RequestOptions`	-

Returns

Promise<void>

importSources.createImportSchedule

createImportSchedule: (parameters, options?) => Promise<{
[key: string]: unknown;
  collectionId?: string;
  created?: Date;
  id?: string;
  importSourceId?: string;
  runInterval?: string & object | "ONCE" | "DAILY" | "WEEKLY" | "MONTHLY";
  startTime?: Date;
  updated?: Date;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `callbackUrl?`: `string` \| `null`; `importSourceId`: `string`; `runInterval`: `string` & `object` \| `"ONCE"` \| `"DAILY"` \| `"WEEKLY"` \| `"MONTHLY"`; `startTime`: `unknown`; }	-
`parameters.callbackUrl?`	`string` \| `null`	Optional webhook URL to call after each scheduled import execution. The URL will receive a POST request with execution status.
`parameters.importSourceId?`	`string`	The ID of the import source to schedule
`parameters.runInterval?`	`string` & `object` \| `"ONCE"` \| `"DAILY"` \| `"WEEKLY"` \| `"MONTHLY"`	The frequency of the scheduled import. ONCE: runs only at startTime. DAILY: runs every day at the specified time. WEEKLY: runs every 7 days. MONTHLY: runs on the same day of each month.
`parameters.startTime?`	`unknown`	The date and time when the first import should execute, in ISO 8601 format (e.g., '2024-01-15T02:00:00Z'). Must be in the future.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; collectionId?: string; created?: Date; id?: string; importSourceId?: string; runInterval?: string & object | "ONCE" | "DAILY" | "WEEKLY" | "MONTHLY"; startTime?: Date; updated?: Date; }>

importSources.deleteImportSchedule

deleteImportSchedule: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `importScheduleId`: `string`; `importSourceId`: `string`; }	-
`parameters.importScheduleId`	`string`	The ID of the import schedule to delete
`parameters.importSourceId?`	`string`	The ID of the import source
`options?`	`RequestOptions`	-

Returns

Promise<void>

importSources.generateImportSourceToken

generateImportSourceToken: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type
`parameters`	{ `importSourceId`: `string`; }
`parameters.importSourceId`	`string`
`options?`	`RequestOptions`

Returns

Promise<void>

importSources.getImportConfigurationStatus

getImportConfigurationStatus: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `importSourceId`: `string`; }	-
`parameters.importSourceId`	`string`	The importSourceId of the import source configuration for the external import
`options?`	`RequestOptions`	-

Returns

Promise<void>

importSources.getImportExecutionStatus

getImportExecutionStatus: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `importExecutionId`: `string`; `importSourceId`: `string`; }	-
`parameters.importExecutionId`	`string`	The importExecutionId of the import
`parameters.importSourceId?`	`string`	The importSourceId of the import source configuration for the external import
`options?`	`RequestOptions`	-

Returns

Promise<void>

importSources.getImportSchedule

getImportSchedule: (parameters, options?) => Promise<{
[key: string]: unknown;
  collectionId?: string;
  created?: Date;
  id?: string;
  importSourceId?: string;
  runInterval?: string & object | "ONCE" | "DAILY" | "WEEKLY" | "MONTHLY";
  startTime?: Date;
  updated?: Date;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `importScheduleId`: `string`; `importSourceId`: `string`; }	-
`parameters.importScheduleId`	`string`	The ID of the import schedule
`parameters.importSourceId?`	`string`	The ID of the import source
`options?`	`RequestOptions`	-

Returns

importSources.getImportScheduleLinks

getImportScheduleLinks: (parameters, options?) => Promise<{
[key: string]: unknown;
  links?: {
   [key: string]: unknown;
     createSchedule: string;
     schedule?: string;
  };
  result?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `importSourceId`: `string`; }	-
`parameters.importSourceId`	`string`	The importSourceId of the import source configuration for the external import
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; links?: { [key: string]: unknown; createSchedule: string; schedule?: string; }; result?: string; }>

importSources.getImportSource

getImportSource: (parameters, options?) => Promise<{
[key: string]: unknown;
  collectionId?: string;
  created?: Date;
  dateFormat?: string;
  dateTimeFormat?: string;
  defaultConcatenator?: string;
  defaultHandleComputeIssueValues?: string | null;
  defaultHandleEmptyValues?: string;
  defaultHandleNotMappedValues?: string | null;
  defaultHandleNullValues?: string | null;
  defaultHandleUnknownValues?: string;
  description?: string | null;
  id?: string;
  importExecutionType?: string | null;
  importSourceModuleKey?:   | string & object
     | "rlabs-import-type-csv"
     | "rlabs-import-type-json"
     | "rlabs-import-type-external"
     | "insight-discovery-import"
     | "rlabs-import-type-dm-csv";
  importSourceOTEntries?: object[] | null;
  importSpecificConfiguration?: string;
  importStatus?:   | {
   [key: string]: unknown;
     configurationAuiLozenge?: string;
     configurationStatusType?: string & object | "ENABLED" | "DISABLED" | null;
     name?: string;
     reasonForInvalidity?: Record<string, any> | null;
     validation?: string;
     validationAuiLozenge?: string;
     validationStatusType?:   | string & object
        | "VALID"
        | "INVALID_CONFIGURATION"
        | "MODULE_UNINSTALLED"
        | null;
   }
     | null;
  integratedImportTypeExtensionId?: string | null;
  integratedImportTypeId?: number | null;
  isImportSourceSchedulingEnabled?: boolean | null;
  name?: string;
  objectSchemaId?: string;
  scheduledImportDetails?:   | {
   [key: string]: unknown;
     createdAt?: Date;
     importScheduleId?: string;
     nextScheduledTime?: Date;
     runFrequency?: string & object | "ONCE" | "DAILY" | "WEEKLY" | "MONTHLY";
     startTime?: Date;
   }
     | null;
  tokenGenerated?: boolean | null;
  updated?: Date;
  url?: string | null;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The unique identifier of the import source
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; collectionId?: string; created?: Date; dateFormat?: string; dateTimeFormat?: string; defaultConcatenator?: string; defaultHandleComputeIssueValues?: string | null; defaultHandleEmptyValues?: string; defaultHandleNotMappedValues?: string | null; defaultHandleNullValues?: string | null; defaultHandleUnknownValues?: string; description?: string | null; id?: string; importExecutionType?: string | null; importSourceModuleKey?: | string & object | "rlabs-import-type-csv" | "rlabs-import-type-json" | "rlabs-import-type-external" | "insight-discovery-import" | "rlabs-import-type-dm-csv"; importSourceOTEntries?: object[] | null; importSpecificConfiguration?: string; importStatus?: | { [key: string]: unknown; configurationAuiLozenge?: string; configurationStatusType?: string & object | "ENABLED" | "DISABLED" | null; name?: string; reasonForInvalidity?: Record<string, any> | null; validation?: string; validationAuiLozenge?: string; validationStatusType?: | string & object | "VALID" | "INVALID_CONFIGURATION" | "MODULE_UNINSTALLED" | null; } | null; integratedImportTypeExtensionId?: string | null; integratedImportTypeId?: number | null; isImportSourceSchedulingEnabled?: boolean | null; name?: string; objectSchemaId?: string; scheduledImportDetails?: | { [key: string]: unknown; createdAt?: Date; importScheduleId?: string; nextScheduledTime?: Date; runFrequency?: string & object | "ONCE" | "DAILY" | "WEEKLY" | "MONTHLY"; startTime?: Date; } | null; tokenGenerated?: boolean | null; updated?: Date; url?: string | null; }>

importSources.getLatestImportExecutionStatus

getLatestImportExecutionStatus: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `importSourceId`: `string`; }	-
`parameters.importSourceId`	`string`	The importSourceId of the import source configuration for the external import
`options?`	`RequestOptions`	-

Returns

Promise<void>

importSources.getSchemaAndMapping

getSchemaAndMapping: (parameters, options?) => Promise<{
[key: string]: unknown;
  mapping?: Record<string, any>;
  schema?: Record<string, any>;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `importSourceId`: `string`; }	-
`parameters.importSourceId`	`string`	The importSourceId of the import source configuration. For use with external imports only
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; mapping?: Record<string, any>; schema?: Record<string, any>; }>

importSources.getSchemaAndMappingProgress

getSchemaAndMappingProgress: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `importSourceId`: `string`; `resourceId`: `string`; }	-
`parameters.importSourceId`	`string`	The importSourceId of the import source configuration for the external import
`parameters.resourceId?`	`string`	The resourceId references the running schema and mapping operation
`options?`	`RequestOptions`	-

Returns

Promise<void>

importSources.startImportExecution

startImportExecution: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `importSourceId`: `string`; }	-
`parameters.importSourceId`	`string`	The importSourceId of the import source configuration for the external import
`options?`	`RequestOptions`	-

Returns

Promise<void>

importSources.submitImportExecutionData

submitImportExecutionData: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `body?`: `Record`<`string`, `any`>; `importExecutionId`: `string`; `importSourceId`: `string`; }	-
`parameters.body?`	`Record`<`string`, `any`>	-
`parameters.importExecutionId?`	`string`	The importExecutionId of the import
`parameters.importSourceId?`	`string`	The importSourceId of the import source configuration for the external import
`options?`	`RequestOptions`	-

Returns

Promise<void>

importSources.submitImportExecutionProgress

submitImportExecutionProgress: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `body?`: `Record`<`string`, `any`>; `importExecutionId`: `string`; `importSourceId`: `string`; }	-
`parameters.body?`	`Record`<`string`, `any`>	-
`parameters.importExecutionId?`	`string`	The importExecutionId of the import
`parameters.importSourceId?`	`string`	The importSourceId of the import source configuration for the external import
`options?`	`RequestOptions`	-

Returns

Promise<void>

importSources.submitSchemaAndMapping

submitSchemaAndMapping: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `async?`: `boolean`; `importSourceId`: `string`; `mapping?`: `Record`<`string`, `any`>; `schema?`: `Record`<`string`, `any`>; }	-
`parameters.async?`	`boolean`	Execute the operation asynchronously
`parameters.importSourceId?`	`string`	The uuid of the import source configuration for the external import
`parameters.mapping?`	`Record`<`string`, `any`>	Object type and attribute mapping configuration for the import.
`parameters.schema?`	`Record`<`string`, `any`>	Object schema and status schema configuration for the import.
`options?`	`RequestOptions`	-

Returns

Promise<void>

importSources.updateImportSchedule

updateImportSchedule: (parameters, options?) => Promise<{
[key: string]: unknown;
  collectionId?: string;
  created?: Date;
  id?: string;
  importSourceId?: string;
  runInterval?: string & object | "ONCE" | "DAILY" | "WEEKLY" | "MONTHLY";
  startTime?: Date;
  updated?: Date;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `callbackUrl?`: `string` \| `null`; `importScheduleId`: `string`; `importSourceId`: `string`; `runInterval`: `string` & `object` \| `"ONCE"` \| `"DAILY"` \| `"WEEKLY"` \| `"MONTHLY"`; `startTime`: `unknown`; }	-
`parameters.callbackUrl?`	`string` \| `null`	Optional webhook URL to call after each scheduled import execution. The URL will receive a POST request with execution status.
`parameters.importScheduleId?`	`string`	The ID of the import schedule to update
`parameters.importSourceId?`	`string`	The ID of the import source
`parameters.runInterval?`	`string` & `object` \| `"ONCE"` \| `"DAILY"` \| `"WEEKLY"` \| `"MONTHLY"`	The frequency of the scheduled import. ONCE: runs only at startTime. DAILY: runs every day at the specified time. WEEKLY: runs every 7 days. MONTHLY: runs on the same day of each month.
`parameters.startTime?`	`unknown`	The date and time when the first import should execute, in ISO 8601 format (e.g., '2024-01-15T02:00:00Z'). Must be in the future.
`options?`	`RequestOptions`	-

Returns

importSources.updateSchemaAndMapping

updateSchemaAndMapping: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `async?`: `boolean`; `importSourceId`: `string`; `mapping?`: `Record`<`string`, `any`>; `schema?`: `Record`<`string`, `any`>; }	-
`parameters.async?`	`boolean`	Execute the operation asynchronously
`parameters.importSourceId?`	`string`	The uuid of the import source configuration for the external import
`parameters.mapping?`	`Record`<`string`, `any`>	Object type and attribute mapping configuration for the import.
`parameters.schema?`	`Record`<`string`, `any`>	Object schema and status schema configuration for the import.
`options?`	`RequestOptions`	-

Returns

Promise<void>

objects

objects: object;

objects.countObjectsByAql

countObjectsByAql: (parameters, options?) => Promise<{
[key: string]: unknown;
  totalCount?: number;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `qlQuery`: `string`; }	-
`parameters.qlQuery`	`string`	The AQL that will filter the objects.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; totalCount?: number; }>

objects.createObject

createObject: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links: {
   [key: string]: unknown;
     self: string;
  };
  attributes?: object[];
  avatar: {
   [key: string]: unknown;
     avatarUUID?: string;
     globalId: string;
     id?: string;
     objectId: string;
     url144: string;
     url16: string;
     url288: string;
     url48: string;
     url72: string;
     workspaceId: string;
  };
  created: Date;
  globalId: string;
  hasAvatar: boolean;
  id: string;
  label: string;
  objectKey: string;
  objectType: {
   [key: string]: unknown;
     abstractObjectType: boolean;
     created: Date;
     description?: string;
     globalId: string;
     icon: {
      [key: string]: unknown;
        id: string;
        name: string;
        url16: string;
        url48: string;
     };
     id: string;
     inherited: boolean;
     name: string;
     objectCount: number;
     objectSchemaId: string;
     parentObjectTypeId?: number;
     parentObjectTypeInherited: boolean;
     position: number;
     type?: number;
     updated: Date;
     workspaceId: string;
  };
  timestamp: number;
  updated: Date;
  workspaceId: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `attributes`: `object`[]; `avatarUUID?`: `string`; `hasAvatar?`: `boolean`; `objectTypeId`: `string`; }	-
`parameters.attributes`	`object`[]	-
`parameters.avatarUUID?`	`string`	The UUID as retrieved by uploading an avatar.
`parameters.hasAvatar?`	`boolean`	-
`parameters.objectTypeId?`	`string`	The object type determines where the object should be stored and which attributes are available
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _links: { [key: string]: unknown; self: string; }; attributes?: object[]; avatar: { [key: string]: unknown; avatarUUID?: string; globalId: string; id?: string; objectId: string; url144: string; url16: string; url288: string; url48: string; url72: string; workspaceId: string; }; created: Date; globalId: string; hasAvatar: boolean; id: string; label: string; objectKey: string; objectType: { [key: string]: unknown; abstractObjectType: boolean; created: Date; description?: string; globalId: string; icon: { [key: string]: unknown; id: string; name: string; url16: string; url48: string; }; id: string; inherited: boolean; name: string; objectCount: number; objectSchemaId: string; parentObjectTypeId?: number; parentObjectTypeInherited: boolean; position: number; type?: number; updated: Date; workspaceId: string; }; timestamp: number; updated: Date; workspaceId: string; }>

objects.deleteObject

deleteObject: (parameters, options?) => Promise<unknown>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The object id to operate on
`options?`	`RequestOptions`	-

Returns

Promise<unknown>

objects.findObjectAttributes

findObjectAttributes: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The object id to operate on
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

objects.findObjectHistory

findObjectHistory: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `asc?`: `boolean`; `id`: `string`; }	-
`parameters.asc?`	`boolean`	Should the history be retrieved in ascending order
`parameters.id?`	`string`	The object id to operate on
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

objects.findObjectReferenceInfo

findObjectReferenceInfo: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The object id to operate on
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

objects.findObjectsByAql

findObjectsByAql: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  last: boolean;
  maxResults: number;
  objectTypeAttributes: object[];
  startAt: number;
  values: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `includeAttributes?`: `boolean`; `maxResults?`: `number`; `qlQuery`: `string`; `startAt?`: `number`; }	-
`parameters.includeAttributes?`	`boolean`	Should the objects attributes be included in the response. If this parameter is false only the information on the object will be returned and the object attributes will not be present
`parameters.maxResults?`	`number`	The maximum number of objects to return in this page of results. Actual number of results may be less, for example, if the last page of results is returned.
`parameters.qlQuery?`	`string`	The AQL that will fetch the objects.
`parameters.startAt?`	`number`	The starting index for the next page of results
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; last: boolean; maxResults: number; objectTypeAttributes: object[]; startAt: number; values: object[]; }>

objects.loadObject

loadObject: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links: {
   [key: string]: unknown;
     self: string;
  };
  attributes?: object[];
  avatar: {
   [key: string]: unknown;
     avatarUUID?: string;
     globalId: string;
     id?: string;
     objectId: string;
     url144: string;
     url16: string;
     url288: string;
     url48: string;
     url72: string;
     workspaceId: string;
  };
  created: Date;
  globalId: string;
  hasAvatar: boolean;
  id: string;
  label: string;
  objectKey: string;
  objectType: {
   [key: string]: unknown;
     abstractObjectType: boolean;
     created: Date;
     description?: string;
     globalId: string;
     icon: {
      [key: string]: unknown;
        id: string;
        name: string;
        url16: string;
        url48: string;
     };
     id: string;
     inherited: boolean;
     name: string;
     objectCount: number;
     objectSchemaId: string;
     parentObjectTypeId?: number;
     parentObjectTypeInherited: boolean;
     position: number;
     type?: number;
     updated: Date;
     workspaceId: string;
  };
  timestamp: number;
  updated: Date;
  workspaceId: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The object id to operate on
`options?`	`RequestOptions`	-

Returns

objects.updateObject

updateObject: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links: {
   [key: string]: unknown;
     self: string;
  };
  attributes?: object[];
  avatar: {
   [key: string]: unknown;
     avatarUUID?: string;
     globalId: string;
     id?: string;
     objectId: string;
     url144: string;
     url16: string;
     url288: string;
     url48: string;
     url72: string;
     workspaceId: string;
  };
  created: Date;
  globalId: string;
  hasAvatar: boolean;
  id: string;
  label: string;
  objectKey: string;
  objectType: {
   [key: string]: unknown;
     abstractObjectType: boolean;
     created: Date;
     description?: string;
     globalId: string;
     icon: {
      [key: string]: unknown;
        id: string;
        name: string;
        url16: string;
        url48: string;
     };
     id: string;
     inherited: boolean;
     name: string;
     objectCount: number;
     objectSchemaId: string;
     parentObjectTypeId?: number;
     parentObjectTypeInherited: boolean;
     position: number;
     type?: number;
     updated: Date;
     workspaceId: string;
  };
  timestamp: number;
  updated: Date;
  workspaceId: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `attributes`: `object`[]; `avatarUUID?`: `string`; `hasAvatar?`: `boolean`; `id`: `string`; `objectTypeId`: `string`; }	-
`parameters.attributes`	`object`[]	-
`parameters.avatarUUID?`	`string`	The UUID as retrieved by uploading an avatar.
`parameters.hasAvatar?`	`boolean`	-
`parameters.id?`	`string`	The object id to operate on
`parameters.objectTypeId?`	`string`	The object type determines where the object should be stored and which attributes are available
`options?`	`RequestOptions`	-

Returns

objectSchemas

objectSchemas: object;

objectSchemas.createSchema

createSchema: (parameters, options?) => Promise<{
[key: string]: unknown;
  canManage?: boolean;
  created: Date;
  description?: string;
  globalId: string;
  id: string;
  name: string;
  objectCount: number;
  objectSchemaKey: string;
  objectTypeCount: number;
  status?: string;
  updated: Date;
  workspaceId: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `description?`: `string`; `name`: `string`; `objectSchemaKey`: `string`; }
`parameters.description?`	`string`
`parameters.name?`	`string`
`parameters.objectSchemaKey?`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; canManage?: boolean; created: Date; description?: string; globalId: string; id: string; name: string; objectCount: number; objectSchemaKey: string; objectTypeCount: number; status?: string; updated: Date; workspaceId: string; }>

objectSchemas.deleteSchema

deleteSchema: (parameters, options?) => Promise<{
[key: string]: unknown;
  canManage?: boolean;
  created: Date;
  description?: string;
  globalId: string;
  id: string;
  name: string;
  objectCount: number;
  objectSchemaKey: string;
  objectTypeCount: number;
  status?: string;
  updated: Date;
  workspaceId: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The object schema id
`options?`	`RequestOptions`	-

Returns

objectSchemas.findSchemaAttributes

findSchemaAttributes: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `extended?`: `boolean`; `id`: `string`; `onlyValueEditable?`: `boolean`; `query?`: `string`; }	-
`parameters.extended?`	`boolean`	Include the object type with each object type attribute
`parameters.id?`	`string`	The object schema id
`parameters.onlyValueEditable?`	`boolean`	Return only values that are associated with values that can be edited
`parameters.query?`	`string`	A query that will be used to filter object type attributes by their name
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

objectSchemas.findSchemaObjectTypes

findSchemaObjectTypes: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `excludeAbstract?`: `boolean`; `id`: `string`; }	-
`parameters.excludeAbstract?`	`boolean`	If true, filters out Abstract Object Types from the results
`parameters.id?`	`string`	The object schema id
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

objectSchemas.findSchemaObjectTypesFlat

findSchemaObjectTypesFlat: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `exclude?`: `string`; `id`: `string`; `includeObjectCounts?`: `boolean`; `query?`: `boolean`; }	-
`parameters.exclude?`	`string`	Exclude objects with this name
`parameters.id?`	`string`	The object schema id
`parameters.includeObjectCounts?`	`boolean`	If true, the objectCount attribute is populated for each object type
`parameters.query?`	`boolean`	Object Type Names to search for
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

objectSchemas.findSchemas

findSchemas: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  last?: boolean;
  maxResults: number;
  startAt: number;
  total: number;
  values: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `includeCounts?`: `boolean`; `maxResults?`: `number`; `startAt?`: `number`; }	-
`parameters.includeCounts?`	`boolean`	Should the object and object type count for schema be included in the response. If this parameter is false, object and object type count will return 0.
`parameters.maxResults?`	`number`	The maximum number of objects to return in this page of results. Actual number of results may be less, for example, if the last page of results is returned.
`parameters.startAt?`	`number`	The starting index for the next page of results
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLast?: boolean; last?: boolean; maxResults: number; startAt: number; total: number; values: object[]; }>

objectSchemas.loadSchema

loadSchema: (parameters, options?) => Promise<{
[key: string]: unknown;
  canManage?: boolean;
  created: Date;
  description?: string;
  globalId: string;
  id: string;
  name: string;
  objectCount: number;
  objectSchemaKey: string;
  objectTypeCount: number;
  status?: string;
  updated: Date;
  workspaceId: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The object schema id
`options?`	`RequestOptions`	-

Returns

objectSchemas.updateSchema

updateSchema: (parameters, options?) => Promise<{
[key: string]: unknown;
  canManage?: boolean;
  created: Date;
  description?: string;
  globalId: string;
  id: string;
  name: string;
  objectCount: number;
  objectSchemaKey: string;
  objectTypeCount: number;
  status?: string;
  updated: Date;
  workspaceId: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `description?`: `string`; `id`: `string`; `name?`: `string`; `objectSchemaKey?`: `string`; }	-
`parameters.description?`	`string`	-
`parameters.id?`	`string`	The object schema id
`parameters.name?`	`string`	-
`parameters.objectSchemaKey?`	`string`	-
`options?`	`RequestOptions`	-

Returns

objectTypeAttributes

objectTypeAttributes: object;

objectTypeAttributes.createObjectTypeAttribute

createObjectTypeAttribute: (parameters, options?) => Promise<{
[key: string]: unknown;
  additionalValue?: string;
  defaultType?:   | {
   [key: string]: unknown;
     id: -1;
     name: "None";
   }
     | {
   [key: string]: unknown;
     id: 0;
     name: "Text";
   }
     | {
   [key: string]: unknown;
     id: 1;
     name: "Integer";
   }
     | {
   [key: string]: unknown;
     id: 2;
     name: "Boolean";
   }
     | {
   [key: string]: unknown;
     id: 3;
     name: "Double";
   }
     | {
   [key: string]: unknown;
     id: 4;
     name: "Date";
   }
     | {
   [key: string]: unknown;
     id: 5;
     name: "Time";
   }
     | {
   [key: string]: unknown;
     id: 6;
     name: "DateTime";
   }
     | {
   [key: string]: unknown;
     id: 7;
     name: "Url";
   }
     | {
   [key: string]: unknown;
     id: 8;
     name: "Email";
   }
     | {
   [key: string]: unknown;
     id: 9;
     name: "Textarea";
   }
     | {
   [key: string]: unknown;
     id: 10;
     name: "Select";
   }
     | {
   [key: string]: unknown;
     id: 11;
     name: "IP Address";
   };
  description?: string;
  editable?: boolean;
  globalId: string;
  hidden?: boolean;
  id: string;
  includeChildObjectTypes?: boolean;
  indexed: boolean;
  label: boolean;
  maximumCardinality?: number;
  minimumCardinality?: number;
  name?: string;
  objectType?: {
   [key: string]: unknown;
     abstractObjectType: boolean;
     created: Date;
     description?: string;
     globalId: string;
     icon: {
      [key: string]: unknown;
        id: string;
        name: string;
        url16: string;
        url48: string;
     };
     id: string;
     inherited: boolean;
     name: string;
     objectCount: number;
     objectSchemaId: string;
     parentObjectTypeId?: number;
     parentObjectTypeInherited: boolean;
     position: number;
     type?: number;
     updated: Date;
     workspaceId: string;
  };
  options?: string;
  position: number;
  qlQuery?: string;
  referenceObjectType?: {
   [key: string]: unknown;
     abstractObjectType: boolean;
     created: Date;
     description?: string;
     globalId: string;
     icon: {
      [key: string]: unknown;
        id: string;
        name: string;
        url16: string;
        url48: string;
     };
     id: string;
     inherited: boolean;
     name: string;
     objectCount: number;
     objectSchemaId: string;
     parentObjectTypeId?: number;
     parentObjectTypeInherited: boolean;
     position: number;
     type?: number;
     updated: Date;
     workspaceId: string;
  };
  referenceObjectTypeId?: string;
  referenceType?: {
   [key: string]: unknown;
     cdmData?: {
      [key: string]: unknown;
        types?: ...[];
     };
     color?: string;
     description?: string;
     globalId: string;
     id?: string;
     name: string;
     objectSchemaId?: string;
     url16?: string;
     workspaceId: string;
  };
  regexValidation?: string;
  removable?: boolean;
  sortable?: boolean;
  suffix?: string;
  summable?: boolean;
  system?: boolean;
  type?: number;
  typeValue?: string;
  typeValueMulti?: string[];
  uniqueAttribute?: boolean;
  workspaceId: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `additionalValue?`: `string`; `defaultTypeId?`: `number`; `description?`: `string`; `hidden?`: `boolean`; `includeChildObjectTypes?`: `boolean`; `label?`: `boolean`; `maximumCardinality?`: `number`; `minimumCardinality?`: `number`; `name`: `string`; `objectTypeId`: `string`; `options?`: `string`; `qlQuery?`: `string`; `regexValidation?`: `string`; `suffix?`: `string`; `summable?`: `boolean`; `type`: `number`; `typeValue?`: `string`; `typeValueMulti?`: `string`[]; `uniqueAttribute?`: `boolean`; }	-
`parameters.additionalValue?`	`string`	Valid for Type Url, User, Object and Confluence. For Url (DISABLED, ENABLED), for Object (ReferenceTypeId), for User (SHOW_PROFILE, HIDE_PROFILE), for Confluence (Confluence Space Id). It is mandatory for Type = Object reference
`parameters.defaultTypeId?`	`number`
`parameters.description?`	`string`	-
`parameters.hidden?`	`boolean`	Hide the object type attributes for Assets Users
`parameters.includeChildObjectTypes?`	`boolean`	Valid for Type = Object reference and describes if children object types should be included in the selectable objects as well
`parameters.label?`	`boolean`	-
`parameters.maximumCardinality?`	`number`	Valid for Type Email, Select, Object, User, Group, Version and Project
`parameters.minimumCardinality?`	`number`	Valid for Type Email, Select, Object, User, Group, Version and Project
`parameters.name?`	`string`	-
`parameters.objectTypeId?`	`string`	The object type id that has this object type attribute associated with it
`parameters.options?`	`string`	Valid for Type Select. A comma separated list of all chosable options
`parameters.qlQuery?`	`string`	Valid for Type object reference. Allows specifying an AQL query to restrict which objects are selectable.
`parameters.regexValidation?`	`string`	Valid for Type Text and Email
`parameters.suffix?`	`string`	Valid for Integer and Double object type attributes
`parameters.summable?`	`boolean`	Valid for Type Integer and Double. Should a sum be included in the view
`parameters.type?`	`number`
`parameters.typeValue?`	`string`	It is mandatory for Type = Object reference and should point to the referenced object type id
`parameters.typeValueMulti?`	`string`[]	Valid for Type User. The Jira groups to restrict selection to
`parameters.uniqueAttribute?`	`boolean`	Should the values be unique for object attributes associated with this object type attribute
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; additionalValue?: string; defaultType?: | { [key: string]: unknown; id: -1; name: "None"; } | { [key: string]: unknown; id: 0; name: "Text"; } | { [key: string]: unknown; id: 1; name: "Integer"; } | { [key: string]: unknown; id: 2; name: "Boolean"; } | { [key: string]: unknown; id: 3; name: "Double"; } | { [key: string]: unknown; id: 4; name: "Date"; } | { [key: string]: unknown; id: 5; name: "Time"; } | { [key: string]: unknown; id: 6; name: "DateTime"; } | { [key: string]: unknown; id: 7; name: "Url"; } | { [key: string]: unknown; id: 8; name: "Email"; } | { [key: string]: unknown; id: 9; name: "Textarea"; } | { [key: string]: unknown; id: 10; name: "Select"; } | { [key: string]: unknown; id: 11; name: "IP Address"; }; description?: string; editable?: boolean; globalId: string; hidden?: boolean; id: string; includeChildObjectTypes?: boolean; indexed: boolean; label: boolean; maximumCardinality?: number; minimumCardinality?: number; name?: string; objectType?: { [key: string]: unknown; abstractObjectType: boolean; created: Date; description?: string; globalId: string; icon: { [key: string]: unknown; id: string; name: string; url16: string; url48: string; }; id: string; inherited: boolean; name: string; objectCount: number; objectSchemaId: string; parentObjectTypeId?: number; parentObjectTypeInherited: boolean; position: number; type?: number; updated: Date; workspaceId: string; }; options?: string; position: number; qlQuery?: string; referenceObjectType?: { [key: string]: unknown; abstractObjectType: boolean; created: Date; description?: string; globalId: string; icon: { [key: string]: unknown; id: string; name: string; url16: string; url48: string; }; id: string; inherited: boolean; name: string; objectCount: number; objectSchemaId: string; parentObjectTypeId?: number; parentObjectTypeInherited: boolean; position: number; type?: number; updated: Date; workspaceId: string; }; referenceObjectTypeId?: string; referenceType?: { [key: string]: unknown; cdmData?: { [key: string]: unknown; types?: ...[]; }; color?: string; description?: string; globalId: string; id?: string; name: string; objectSchemaId?: string; url16?: string; workspaceId: string; }; regexValidation?: string; removable?: boolean; sortable?: boolean; suffix?: string; summable?: boolean; system?: boolean; type?: number; typeValue?: string; typeValueMulti?: string[]; uniqueAttribute?: boolean; workspaceId: string; }>

objectTypeAttributes.deleteObjectTypeAttribute

deleteObjectTypeAttribute: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The object type attribute id to be manipulated
`options?`	`RequestOptions`	-

Returns

Promise<void>

objectTypeAttributes.updateObjectTypeAttribute

updateObjectTypeAttribute: (parameters, options?) => Promise<{
[key: string]: unknown;
  additionalValue?: string;
  defaultType?:   | {
   [key: string]: unknown;
     id: -1;
     name: "None";
   }
     | {
   [key: string]: unknown;
     id: 0;
     name: "Text";
   }
     | {
   [key: string]: unknown;
     id: 1;
     name: "Integer";
   }
     | {
   [key: string]: unknown;
     id: 2;
     name: "Boolean";
   }
     | {
   [key: string]: unknown;
     id: 3;
     name: "Double";
   }
     | {
   [key: string]: unknown;
     id: 4;
     name: "Date";
   }
     | {
   [key: string]: unknown;
     id: 5;
     name: "Time";
   }
     | {
   [key: string]: unknown;
     id: 6;
     name: "DateTime";
   }
     | {
   [key: string]: unknown;
     id: 7;
     name: "Url";
   }
     | {
   [key: string]: unknown;
     id: 8;
     name: "Email";
   }
     | {
   [key: string]: unknown;
     id: 9;
     name: "Textarea";
   }
     | {
   [key: string]: unknown;
     id: 10;
     name: "Select";
   }
     | {
   [key: string]: unknown;
     id: 11;
     name: "IP Address";
   };
  description?: string;
  editable?: boolean;
  globalId: string;
  hidden?: boolean;
  id: string;
  includeChildObjectTypes?: boolean;
  indexed: boolean;
  label: boolean;
  maximumCardinality?: number;
  minimumCardinality?: number;
  name?: string;
  objectType?: {
   [key: string]: unknown;
     abstractObjectType: boolean;
     created: Date;
     description?: string;
     globalId: string;
     icon: {
      [key: string]: unknown;
        id: string;
        name: string;
        url16: string;
        url48: string;
     };
     id: string;
     inherited: boolean;
     name: string;
     objectCount: number;
     objectSchemaId: string;
     parentObjectTypeId?: number;
     parentObjectTypeInherited: boolean;
     position: number;
     type?: number;
     updated: Date;
     workspaceId: string;
  };
  options?: string;
  position: number;
  qlQuery?: string;
  referenceObjectType?: {
   [key: string]: unknown;
     abstractObjectType: boolean;
     created: Date;
     description?: string;
     globalId: string;
     icon: {
      [key: string]: unknown;
        id: string;
        name: string;
        url16: string;
        url48: string;
     };
     id: string;
     inherited: boolean;
     name: string;
     objectCount: number;
     objectSchemaId: string;
     parentObjectTypeId?: number;
     parentObjectTypeInherited: boolean;
     position: number;
     type?: number;
     updated: Date;
     workspaceId: string;
  };
  referenceObjectTypeId?: string;
  referenceType?: {
   [key: string]: unknown;
     cdmData?: {
      [key: string]: unknown;
        types?: ...[];
     };
     color?: string;
     description?: string;
     globalId: string;
     id?: string;
     name: string;
     objectSchemaId?: string;
     url16?: string;
     workspaceId: string;
  };
  regexValidation?: string;
  removable?: boolean;
  sortable?: boolean;
  suffix?: string;
  summable?: boolean;
  system?: boolean;
  type?: number;
  typeValue?: string;
  typeValueMulti?: string[];
  uniqueAttribute?: boolean;
  workspaceId: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `additionalValue?`: `string`; `defaultTypeId?`: `number`; `description?`: `string`; `hidden?`: `boolean`; `id`: `string`; `includeChildObjectTypes?`: `boolean`; `label?`: `boolean`; `maximumCardinality?`: `number`; `minimumCardinality?`: `number`; `name?`: `string`; `objectTypeId`: `string`; `options?`: `string`; `qlQuery?`: `string`; `regexValidation?`: `string`; `suffix?`: `string`; `summable?`: `boolean`; `type?`: `number`; `typeValue?`: `string`; `typeValueMulti?`: `string`[]; `uniqueAttribute?`: `boolean`; }	-
`parameters.additionalValue?`	`string`	Valid for Type Url, User, Object and Confluence. For Url (DISABLED, ENABLED), for Object (ReferenceTypeId), for User (SHOW_PROFILE, HIDE_PROFILE), for Confluence (Confluence Space Id). It is mandatory for Type = Object reference
`parameters.defaultTypeId?`	`number`
`parameters.description?`	`string`	-
`parameters.hidden?`	`boolean`	Hide the object type attributes for Assets Users
`parameters.id?`	`string`	The object type attribute to manipulate
`parameters.includeChildObjectTypes?`	`boolean`	Valid for Type = Object reference and describes if children object types should be included in the selectable objects as well
`parameters.label?`	`boolean`	-
`parameters.maximumCardinality?`	`number`	Valid for Type Email, Select, Object, User, Group, Version and Project
`parameters.minimumCardinality?`	`number`	Valid for Type Email, Select, Object, User, Group, Version and Project
`parameters.name?`	`string`	-
`parameters.objectTypeId?`	`string`	The object type id that has this object type attribute associated with it
`parameters.options?`	`string`	Valid for Type Select. A comma separated list of all chosable options
`parameters.qlQuery?`	`string`	Valid for Type object reference. Allows specifying an AQL query to restrict which objects are selectable.
`parameters.regexValidation?`	`string`	Valid for Type Text and Email
`parameters.suffix?`	`string`	Valid for Integer and Double object type attributes
`parameters.summable?`	`boolean`	Valid for Type Integer and Double. Should a sum be included in the view
`parameters.type?`	`number`
`parameters.typeValue?`	`string`	It is mandatory for Type = Object reference and should point to the referenced object type id
`parameters.typeValueMulti?`	`string`[]	Valid for Type User. The Jira groups to restrict selection to
`parameters.uniqueAttribute?`	`boolean`	Should the values be unique for object attributes associated with this object type attribute
`options?`	`RequestOptions`	-

Returns

objectTypes

objectTypes: object;

objectTypes.changeObjectTypePosition

changeObjectTypePosition: (parameters, options?) => Promise<{
[key: string]: unknown;
  abstractObjectType: boolean;
  created: Date;
  description?: string;
  globalId: string;
  icon: {
   [key: string]: unknown;
     id: string;
     name: string;
     url16: string;
     url48: string;
  };
  id: string;
  inherited: boolean;
  name: string;
  objectCount: number;
  objectSchemaId: string;
  parentObjectTypeId?: number;
  parentObjectTypeInherited: boolean;
  position: number;
  type?: number;
  updated: Date;
  workspaceId: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; `position`: `number`; `toObjectTypeId?`: `string`; }	-
`parameters.id`	`string`	-
`parameters.position?`	`number`	The preffered position
`parameters.toObjectTypeId?`	`string`	The desired new parent of the object type
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; abstractObjectType: boolean; created: Date; description?: string; globalId: string; icon: { [key: string]: unknown; id: string; name: string; url16: string; url48: string; }; id: string; inherited: boolean; name: string; objectCount: number; objectSchemaId: string; parentObjectTypeId?: number; parentObjectTypeInherited: boolean; position: number; type?: number; updated: Date; workspaceId: string; }>

objectTypes.createObjectType

createObjectType: (parameters, options?) => Promise<{
[key: string]: unknown;
  abstractObjectType: boolean;
  created: Date;
  description?: string;
  globalId: string;
  icon: {
   [key: string]: unknown;
     id: string;
     name: string;
     url16: string;
     url48: string;
  };
  id: string;
  inherited: boolean;
  name: string;
  objectCount: number;
  objectSchemaId: string;
  parentObjectTypeId?: number;
  parentObjectTypeInherited: boolean;
  position: number;
  type?: number;
  updated: Date;
  workspaceId: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `abstractObjectType?`: `boolean`; `description?`: `string`; `iconId`: `string`; `inherited?`: `boolean`; `name`: `string`; `objectSchemaId`: `string`; `parentObjectTypeId?`: `string`; }	-
`parameters.abstractObjectType?`	`boolean`	-
`parameters.description?`	`string`	-
`parameters.iconId?`	`string`	-
`parameters.inherited?`	`boolean`	Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
`parameters.name?`	`string`	-
`parameters.objectSchemaId?`	`string`	-
`parameters.parentObjectTypeId?`	`string`	The id of the parent object type
`options?`	`RequestOptions`	-

Returns

objectTypes.deleteObjectType

deleteObjectType: (parameters, options?) => Promise<{
[key: string]: unknown;
  abstractObjectType: boolean;
  created: Date;
  description?: string;
  globalId: string;
  icon: {
   [key: string]: unknown;
     id: string;
     name: string;
     url16: string;
     url48: string;
  };
  id: string;
  inherited: boolean;
  name: string;
  objectCount: number;
  objectSchemaId: string;
  parentObjectTypeId?: number;
  parentObjectTypeInherited: boolean;
  position: number;
  type?: number;
  updated: Date;
  workspaceId: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `id`: `string`; }
`parameters.id`	`string`
`options?`	`RequestOptions`

Returns

objectTypes.findObjectTypeAttributes

findObjectTypeAttributes: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type
`parameters`	{ `excludeParentAttributes?`: `boolean`; `id`: `string`; `includeChildren?`: `boolean`; `includeValuesExist?`: `boolean`; `onlyValueEditable?`: `boolean`; `orderByName?`: `boolean`; `orderByRequired?`: `boolean`; `query?`: `string`; }
`parameters.excludeParentAttributes?`	`boolean`
`parameters.id?`	`string`
`parameters.includeChildren?`	`boolean`
`parameters.includeValuesExist?`	`boolean`
`parameters.onlyValueEditable?`	`boolean`
`parameters.orderByName?`	`boolean`
`parameters.orderByRequired?`	`boolean`
`parameters.query?`	`string`
`options?`	`RequestOptions`

Returns

Promise<object[]>

objectTypes.loadObjectType

loadObjectType: (parameters, options?) => Promise<{
[key: string]: unknown;
  abstractObjectType: boolean;
  created: Date;
  description?: string;
  globalId: string;
  icon: {
   [key: string]: unknown;
     id: string;
     name: string;
     url16: string;
     url48: string;
  };
  id: string;
  inherited: boolean;
  name: string;
  objectCount: number;
  objectSchemaId: string;
  parentObjectTypeId?: number;
  parentObjectTypeInherited: boolean;
  position: number;
  type?: number;
  updated: Date;
  workspaceId: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `id`: `string`; }
`parameters.id`	`string`
`options?`	`RequestOptions`

Returns

objectTypes.updateObjectType

updateObjectType: (parameters, options?) => Promise<{
[key: string]: unknown;
  abstractObjectType: boolean;
  created: Date;
  description?: string;
  globalId: string;
  icon: {
   [key: string]: unknown;
     id: string;
     name: string;
     url16: string;
     url48: string;
  };
  id: string;
  inherited: boolean;
  name: string;
  objectCount: number;
  objectSchemaId: string;
  parentObjectTypeId?: number;
  parentObjectTypeInherited: boolean;
  position: number;
  type?: number;
  updated: Date;
  workspaceId: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `abstractObjectType?`: `boolean`; `description?`: `string`; `iconId?`: `string`; `id`: `string`; `inherited?`: `boolean`; `name?`: `string`; }	-
`parameters.abstractObjectType?`	`boolean`	-
`parameters.description?`	`string`	-
`parameters.iconId?`	`string`	-
`parameters.id?`	`string`	-
`parameters.inherited?`	`boolean`	Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
`parameters.name?`	`string`	-
`options?`	`RequestOptions`	-

Returns

progress

progress: object;

progress.getImportProgress

getImportProgress: (parameters, options?) => Promise<{
[key: string]: unknown;
  actor?: string;
  category?: string;
  currentStep?: number;
  currentStepTotalWorkUnits?: number;
  currentWorkDescription?: string;
  currentWorkUnits?: number;
  estimatedFinishDate?: Date;
  executionUUID?: string;
  finishedDate?: Date;
  numberOfSteps?: number;
  progressInPercent?: number;
  resourceId?: string;
  result?: string;
  resultData?: Record<string, any>;
  resultMessage?: string;
  startDate?: Date;
  status?: string;
  stepDescription?: string;
  totalWorkUnits?: number;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The id of the import source configuration that the progress should be fetched for
`options?`	`RequestOptions`	-

Returns

referenceTypes

referenceTypes: object;

referenceTypes.createReferenceType

createReferenceType: (parameters, options?) => Promise<{
[key: string]: unknown;
  cdmData?: {
   [key: string]: unknown;
     types?: object[];
  };
  color?: string;
  description?: string;
  globalId: string;
  id?: string;
  name: string;
  objectSchemaId?: string;
  url16?: string;
  workspaceId: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `color?`: `string`; `description?`: `string`; `name`: `string`; `objectSchemaId?`: `string`; }
`parameters.color?`	`string`
`parameters.description?`	`string`
`parameters.name?`	`string`
`parameters.objectSchemaId?`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; cdmData?: { [key: string]: unknown; types?: object[]; }; color?: string; description?: string; globalId: string; id?: string; name: string; objectSchemaId?: string; url16?: string; workspaceId: string; }>

referenceTypes.findReferenceTypes

findReferenceTypes: (parameters?, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters?`	{ `includeAll?`: `boolean`; `objectSchemaId?`: `string`; }	-
`parameters.includeAll?`	`boolean`	Include all reference types. Defaults to false
`parameters.objectSchemaId?`	`string`	Include reference types for the object schema id. If supplied reference types for the object schema will be returned otherwise all global will be returned
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

statusTypes

statusTypes: object;

statusTypes.createStatusType

createStatusType: (parameters, options?) => Promise<{
[key: string]: unknown;
  category: number;
  description?: string;
  id: string;
  name: string;
  objectSchemaId?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `category`: `number`; `description?`: `string`; `name`: `string`; `objectSchemaId?`: `string`; }	-
`parameters.category`	`number`
`parameters.description?`	`string`	-
`parameters.name?`	`string`	-
`parameters.objectSchemaId?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; category: number; description?: string; id: string; name: string; objectSchemaId?: string; }>

statusTypes.deleteStatusType

deleteStatusType: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	Status type id
`options?`	`RequestOptions`	-

Returns

Promise<void>

statusTypes.findStatusTypes

findStatusTypes: (parameters?, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters?`	{ `objectSchemaId?`: `string`; }	-
`parameters.objectSchemaId?`	`string`	Include statuses for the object schema id. If supplied statuses for the object schema will be returned otherwise all global will be returned
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

statusTypes.getStatusType

getStatusType: (parameters, options?) => Promise<{
[key: string]: unknown;
  category: number;
  description?: string;
  id: string;
  name: string;
  objectSchemaId?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	Status type id
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; category: number; description?: string; id: string; name: string; objectSchemaId?: string; }>

statusTypes.updateStatusType

updateStatusType: (parameters, options?) => Promise<{
[key: string]: unknown;
  category: number;
  description?: string;
  id: string;
  name: string;
  objectSchemaId?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `category`: `number`; `description?`: `string`; `id`: `string`; `name`: `string`; `objectSchemaId?`: `string`; }	-
`parameters.category`	`number`
`parameters.description?`	`string`	-
`parameters.id?`	`string`	Status type id
`parameters.name?`	`string`	-
`parameters.objectSchemaId?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; category: number; description?: string; id: string; name: string; objectSchemaId?: string; }>

usage

usage: object;

usage.getTenantUsageInfo

getTenantUsageInfo: (options?) => Promise<{
[key: string]: unknown;
  perSchemaUsageInfo: object[];
  totalObjectsCount: number;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; perSchemaUsageInfo: object[]; totalObjectsCount: number; }>

Function: createAssetsClient() ​

Parameters ​

Returns ​

connectedTickets ​

connectedTickets.findObjectTickets ​

Parameters ​

Returns ​

globalConfig ​

globalConfig.updateGlobalConfiguration ​

Parameters ​

Returns ​

icons ​

icons.findGlobalIcons ​

Parameters ​

Returns ​

icons.getIcon ​

Parameters ​

Returns ​

icons.getIconImage ​

Parameters ​

Returns ​

imports ​

imports.startImport ​

Parameters ​

Returns ​

importSources ​

importSources.cancelImportExecution ​

Parameters ​

Returns ​

importSources.createFailedImportHistory ​

Parameters ​

Returns ​

importSources.createImportSchedule ​

Parameters ​

Returns ​

importSources.deleteImportSchedule ​

Parameters ​

Returns ​

importSources.generateImportSourceToken ​

Parameters ​

Returns ​

importSources.getImportConfigurationStatus ​

Parameters ​

Returns ​

importSources.getImportExecutionStatus ​

Parameters ​

Returns ​

importSources.getImportSchedule ​

Parameters ​

Returns ​

importSources.getImportScheduleLinks ​

Parameters ​

Returns ​

importSources.getImportSource ​

Parameters ​

Returns ​

importSources.getLatestImportExecutionStatus ​

Parameters ​

Returns ​

importSources.getSchemaAndMapping ​

Parameters ​

Returns ​

importSources.getSchemaAndMappingProgress ​

Parameters ​

Returns ​

importSources.startImportExecution ​

Parameters ​

Returns ​

importSources.submitImportExecutionData ​

Parameters ​

Returns ​

importSources.submitImportExecutionProgress ​

Parameters ​

Returns ​

importSources.submitSchemaAndMapping ​

Parameters ​

Returns ​

importSources.updateImportSchedule ​

Parameters ​

Returns ​

Function: createAssetsClient()

Parameters

Returns

connectedTickets

connectedTickets.findObjectTickets

Parameters

Returns

globalConfig

globalConfig.updateGlobalConfiguration

Parameters

Returns

icons

icons.findGlobalIcons

Parameters

Returns

icons.getIcon

Parameters

Returns

icons.getIconImage

Parameters

Returns

imports

imports.startImport

Parameters

Returns

importSources

importSources.cancelImportExecution

Parameters

Returns

importSources.createFailedImportHistory

Parameters

Returns

importSources.createImportSchedule

Parameters

Returns

importSources.deleteImportSchedule

Parameters

Returns

importSources.generateImportSourceToken

Parameters

Returns

importSources.getImportConfigurationStatus

Parameters

Returns

importSources.getImportExecutionStatus

Parameters

Returns

importSources.getImportSchedule

Parameters

Returns

importSources.getImportScheduleLinks

Parameters

Returns

importSources.getImportSource

Parameters

Returns

importSources.getLatestImportExecutionStatus

Parameters

Returns

importSources.getSchemaAndMapping

Parameters

Returns

importSources.getSchemaAndMappingProgress

Parameters

Returns

importSources.startImportExecution

Parameters

Returns

importSources.submitImportExecutionData

Parameters

Returns

importSources.submitImportExecutionProgress

Parameters

Returns

importSources.submitSchemaAndMapping

Parameters

Returns

importSources.updateImportSchedule

Parameters

Returns