Function: createAssetsServerClient()

function createAssetsServerClient(clientConfig): object;

Defined in: src/assetsServer/createAssetsServerClient.ts:109

Parameters

Parameter	Type
`clientConfig`	\| `Client` \| `AssetsServerClientConfig`

Returns

object

analytics

analytics: object;

analytics.getSchemaAnalytics

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

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<object[]>

aql

aql: object;

aql.findObjects

findObjects: (parameters?, options?) => Promise<{
[key: string]: unknown;
  abstractObjectType?: boolean;
  conversionPossible?: boolean;
  filters?: object[];
  inheritanceTree?: {
   [key: string]: unknown;
     parentObjectTypeIdsInclSelf?: Record<string, any>;
  };
  iql?: string;
  iqlSearchResult?: boolean;
  matchedFilterValues?: ObjectAttribute[];
  objectEntries?: AssetObject[];
  objectTypeAttributes?: object[];
  objectTypeId?: number;
  objectTypeIsInherited?: boolean;
  orderAscending?: boolean;
  orderByTypeAttrId?: number;
  orderWay?: string;
  pageNumber?: number;
  pageObjectSize?: number;
  pageSize?: number;
  qlQuery?: string;
  qlQuerySearchResult?: boolean;
  startIndex?: number;
  toIndex?: number;
  totalFilterCount?: number;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `includeAttributes?`: `string`; `includeAttributesDeep?`: `string`; `includeExtendedInfo?`: `string`; `includeTypeAttributes?`: `string`; `page?`: `string`; `qlQuery?`: `string`; `resultPerPage?`: `string`; `xoauth_requestor_id?`: `string`; }	-
`parameters.includeAttributes?`	`string`	Should object attributes be included in the response. If this parameter is set to `false`, only the information on the object will be returned and object attributes will not be present.
`parameters.includeAttributesDeep?`	`string`	How many levels of attributes should be included in the response. Example: Consider object A, which has a reference to object B, which has a reference to object C. If object A is included in the response and `includeAttributesDeep=1`, object A's reference to object B will be included in the attributes of object A but object B's reference to object C will not be included. However if `includeAttributesDeep=2`, then object B's reference to object C will be included in object B's attributes.
`parameters.includeExtendedInfo?`	`string`	Should the response include information about open issues and attachments. If the value is set to `true`, each returned object contains information on whether there are open tickets connected to it and if the object has attachments.
`parameters.includeTypeAttributes?`	`string`	Should the response include the object type attribute definition for each attribute that is returned with the objects.
`parameters.page?`	`string`	The page to fetch when paginating through the response.
`parameters.qlQuery?`	`string`	The query to determine which objects should be fetched. For example, `objectType = "Computer"`. An empty query means all objects are fetched.
`parameters.resultPerPage?`	`string`	The number of objects returned per page.
`parameters.xoauth_requestor_id?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; abstractObjectType?: boolean; conversionPossible?: boolean; filters?: object[]; inheritanceTree?: { [key: string]: unknown; parentObjectTypeIdsInclSelf?: Record<string, any>; }; iql?: string; iqlSearchResult?: boolean; matchedFilterValues?: ObjectAttribute[]; objectEntries?: AssetObject[]; objectTypeAttributes?: object[]; objectTypeId?: number; objectTypeIsInherited?: boolean; orderAscending?: boolean; orderByTypeAttrId?: number; orderWay?: string; pageNumber?: number; pageObjectSize?: number; pageSize?: number; qlQuery?: string; qlQuerySearchResult?: boolean; startIndex?: number; toIndex?: number; totalFilterCount?: number; }>

attachments

attachments: object;

attachments.addAttachments

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

Parameters

Parameter	Type	Description
`parameters`	{ `attachments`: \| `AttachmentInput` \| `AttachmentInput`[]; `objectId`: `string`; }	-
`parameters.attachments`	\| `AttachmentInput` \| `AttachmentInput`[]	-
`parameters.objectId?`	`string`	The object ID
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

attachments.deleteAttachment

deleteAttachment: (parameters, options?) => Promise<{
[key: string]: unknown;
  author?: string;
  comment?: string;
  commentOutput?: string;
  created?: Date;
  filename?: string;
  filesize?: string;
  id?: number;
  mimeType?: string;
  url?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `attachmentId`: `string`; }	-
`parameters.attachmentId`	`string`	The attachment ID
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; author?: string; comment?: string; commentOutput?: string; created?: Date; filename?: string; filesize?: string; id?: number; mimeType?: string; url?: string; }>

attachments.getAttachments

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

Parameters

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

Returns

Promise<object[]>

comments

comments: object;

comments.createComment

createComment: (parameters, options?) => Promise<{
[key: string]: unknown;
  actor?: {
   [key: string]: unknown;
     avatarUrl?: string;
     displayName?: string;
     html?: string;
     isDeleted?: boolean;
     key?: string;
     lastSeenVersion?: string;
     name?: string;
     renderedLink?: string;
  };
  canDelete?: boolean;
  canEdit?: boolean;
  comment?: string;
  commentOutput?: string;
  created?: Date;
  id?: number;
  objectId?: number;
  role?: number;
  updated?: Date;
}>;

Parameters

Parameter	Type
`parameters`	{ `actor?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `html?`: `string`; `isDeleted?`: `boolean`; `key?`: `string`; `lastSeenVersion?`: `string`; `name?`: `string`; `renderedLink?`: `string`; }; `canDelete?`: `boolean`; `canEdit?`: `boolean`; `comment?`: `string`; `commentOutput?`: `string`; `created?`: `unknown`; `id?`: `number`; `objectId?`: `number`; `role?`: `number`; `updated?`: `unknown`; }
`parameters.actor?`	{ `avatarUrl?`: `string`; `displayName?`: `string`; `html?`: `string`; `isDeleted?`: `boolean`; `key?`: `string`; `lastSeenVersion?`: `string`; `name?`: `string`; `renderedLink?`: `string`; }
`parameters.actor.avatarUrl?`	`string`
`parameters.actor.displayName?`	`string`
`parameters.actor.html?`	`string`
`parameters.actor.isDeleted?`	`boolean`
`parameters.actor.key?`	`string`
`parameters.actor.lastSeenVersion?`	`string`
`parameters.actor.name?`	`string`
`parameters.actor.renderedLink?`	`string`
`parameters.canDelete?`	`boolean`
`parameters.canEdit?`	`boolean`
`parameters.comment?`	`string`
`parameters.commentOutput?`	`string`
`parameters.created?`	`unknown`
`parameters.id?`	`number`
`parameters.objectId?`	`number`
`parameters.role?`	`number`
`parameters.updated?`	`unknown`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; actor?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; html?: string; isDeleted?: boolean; key?: string; lastSeenVersion?: string; name?: string; renderedLink?: string; }; canDelete?: boolean; canEdit?: boolean; comment?: string; commentOutput?: string; created?: Date; id?: number; objectId?: number; role?: number; updated?: Date; }>

comments.getComments

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

Parameters

Parameter	Type	Description
`parameters`	{ `asc?`: `string`; `objectId`: `string`; }	-
`parameters.asc?`	`string`	Whether to sort ascending
`parameters.objectId?`	`string`	The ID of the object
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

connectedTickets

connectedTickets: object;

connectedTickets.findObjectTickets

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

Parameters

Parameter	Type	Description
`parameters`	{ `filterId?`: `string`; `id`: `string`; `limit?`: `string`; `xoauth_requestor_id?`: `string`; }	-
`parameters.filterId?`	`string`	Filter the tickets based on the filter ID. If filterId is not specified then no filter will be used. In the context of Jira the filterId will be the ID on an existing JQL filter.
`parameters.id?`	`string`	The ID of the object to retrieve tickets for.
`parameters.limit?`	`string`	Limit the result set to the amount of objects. If the limit is not specified all connected tickets will be returned. Unlimited search is discouraged for performance reasons. If the limit is specified, it should not be higher than the max result window configured for the underlying search engine.
`parameters.xoauth_requestor_id?`	`string`	-
`options?`	`RequestOptions`	-

Returns

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

icons

icons: object;

icons.findGlobalIcons

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

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<object[]>

icons.findIcons

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

Parameters

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

Returns

Promise<object[]>

icons.getIcon

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

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The ID of the icon.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; after?: string; expand?: string; id?: number; name?: string; position?: string; project?: string; url16?: string; url48?: string; }>

indexConfiguration

indexConfiguration: object;

indexConfiguration.checkIndexIntegrity

checkIndexIntegrity: (options?) => Promise<{
[key: string]: unknown;
  objectIndexOk?: boolean;
  objectJiraIssueIndexOk?: boolean;
  objectSchemaIndexOk?: boolean;
  objectTypeAttributeIndexOk?: boolean;
  objectTypeIndexOk?: boolean;
  reindexNeeded?: boolean;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; objectIndexOk?: boolean; objectJiraIssueIndexOk?: boolean; objectSchemaIndexOk?: boolean; objectTypeAttributeIndexOk?: boolean; objectTypeIndexOk?: boolean; reindexNeeded?: boolean; }>

indexConfiguration.getIndexPath

getIndexPath: (options?) => Promise<{
[key: string]: unknown;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

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

indexConfiguration.persistIndexToFile

persistIndexToFile: (options?) => Promise<{
[key: string]: unknown;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

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

indexConfiguration.startReindexCurrentNode

startReindexCurrentNode: (options?) => Promise<{
[key: string]: unknown;
  actor?: string;
  category?: string;
  currentStep?: number;
  currentStepTotalWorkUnits?: number;
  currentWorkDescription?: string;
  currentWorkUnits?: number;
  estimatedFinishDate?: Date;
  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
`options?`	`RequestOptions`

Returns

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

indexConfiguration.startReindexInsight

startReindexInsight: (parameters, options?) => Promise<{
[key: string]: unknown;
  actor?: string;
  category?: string;
  currentStep?: number;
  currentStepTotalWorkUnits?: number;
  currentWorkDescription?: string;
  currentWorkUnits?: number;
  estimatedFinishDate?: Date;
  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`	{ `clean?`: `string`; }	-
`parameters.clean?`	`string`	If true, the index will be cleaned before the reindex starts.
`options?`	`RequestOptions`	-

Returns

objectAttributes

objectAttributes: object;

objectAttributes.createObjectAttribute

createObjectAttribute: (parameters, options?) => Promise<ObjectAttribute>;

Parameters

Parameter	Type	Description
`parameters`	{ `includeTypeAttribute?`: `string`; `objectAttributeValues`: `object`[]; `objectId?`: `number`; `objectTypeAttributeId?`: `number`; `operationType?`: `number`; }	-
`parameters.includeTypeAttribute?`	`string`	Should the response include the object type attribute definition
`parameters.objectAttributeValues?`	`object`[]	-
`parameters.objectId?`	`number`	-
`parameters.objectTypeAttributeId?`	`number`	-
`parameters.operationType?`	`number`	-
`options?`	`RequestOptions`	-

Returns

Promise<ObjectAttribute>

objects

objects: object;

objects.archiveObject

archiveObject: (parameters, options?) => Promise<AssetObject>;

Parameters

Parameter	Type	Description
`parameters`	{ `objectIdentifier`: `string`; }	-
`parameters.objectIdentifier`	`string`	The object identifier to archive.
`options?`	`RequestOptions`	-

Returns

Promise<AssetObject>

objects.archiveObjectsByFilter

archiveObjectsByFilter: (parameters, options?) => Promise<{
[key: string]: unknown;
  actor?: string;
  category?: string;
  currentStep?: number;
  currentStepTotalWorkUnits?: number;
  currentWorkDescription?: string;
  currentWorkUnits?: number;
  estimatedFinishDate?: Date;
  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`	{ `filterParams?`: { `asc?`: `number`; `attributesToDisplay?`: { `attributesToDisplayIds?`: `number`[]; }; `attributesToDisplayIds?`: `number`[]; `filters?`: `object`[]; `includeAttributes?`: `boolean`; `objectId?`: `number`; `objectSchemaId?`: `number`; `objectTypeId?`: `number`; `orderByTypeAttrId?`: `number`; `page?`: `number`; `resultsPerPage?`: `number`; }; `iqlParams?`: { `asc?`: `number`; `attributesToDisplay?`: { `attributesToDisplayIds?`: `number`[]; }; `includeAttributes?`: `boolean`; `iql?`: `string`; `objectId?`: `number`; `objectSchemaId?`: `number`; `objectTypeId?`: `number`; `orderByTypeAttrId?`: `number`; `page?`: `number`; `qlQuery?`: `string`; `resultsPerPage?`: `number`; }; `iqlSearch?`: `boolean`; `objectSchemaId?`: `number`; `qlQueryParams?`: { `asc?`: `number`; `attributesToDisplay?`: { `attributesToDisplayIds?`: `number`[]; }; `includeAttributes?`: `boolean`; `iql?`: `string`; `objectId?`: `number`; `objectSchemaId?`: `number`; `objectTypeId?`: `number`; `orderByTypeAttrId?`: `number`; `page?`: `number`; `qlQuery?`: `string`; `resultsPerPage?`: `number`; }; `qlQuerySearch?`: `boolean`; `typeId?`: `string`; }	-
`parameters.filterParams?`	{ `asc?`: `number`; `attributesToDisplay?`: { `attributesToDisplayIds?`: `number`[]; }; `attributesToDisplayIds?`: `number`[]; `filters?`: `object`[]; `includeAttributes?`: `boolean`; `objectId?`: `number`; `objectSchemaId?`: `number`; `objectTypeId?`: `number`; `orderByTypeAttrId?`: `number`; `page?`: `number`; `resultsPerPage?`: `number`; }	-
`parameters.filterParams.asc?`	`number`	-
`parameters.filterParams.attributesToDisplay?`	{ `attributesToDisplayIds?`: `number`[]; }	-
`parameters.filterParams.attributesToDisplay.attributesToDisplayIds?`	`number`[]	-
`parameters.filterParams.attributesToDisplayIds?`	`number`[]	-
`parameters.filterParams.filters?`	`object`[]	-
`parameters.filterParams.includeAttributes?`	`boolean`	-
`parameters.filterParams.objectId?`	`number`	-
`parameters.filterParams.objectSchemaId?`	`number`	-
`parameters.filterParams.objectTypeId?`	`number`	-
`parameters.filterParams.orderByTypeAttrId?`	`number`	-
`parameters.filterParams.page?`	`number`	-
`parameters.filterParams.resultsPerPage?`	`number`	-
`parameters.iqlParams?`	{ `asc?`: `number`; `attributesToDisplay?`: { `attributesToDisplayIds?`: `number`[]; }; `includeAttributes?`: `boolean`; `iql?`: `string`; `objectId?`: `number`; `objectSchemaId?`: `number`; `objectTypeId?`: `number`; `orderByTypeAttrId?`: `number`; `page?`: `number`; `qlQuery?`: `string`; `resultsPerPage?`: `number`; }	-
`parameters.iqlParams.asc?`	`number`	-
`parameters.iqlParams.attributesToDisplay?`	{ `attributesToDisplayIds?`: `number`[]; }	-
`parameters.iqlParams.attributesToDisplay.attributesToDisplayIds?`	`number`[]	-
`parameters.iqlParams.includeAttributes?`	`boolean`	-
`parameters.iqlParams.iql?`	`string`	-
`parameters.iqlParams.objectId?`	`number`	-
`parameters.iqlParams.objectSchemaId?`	`number`	-
`parameters.iqlParams.objectTypeId?`	`number`	-
`parameters.iqlParams.orderByTypeAttrId?`	`number`	-
`parameters.iqlParams.page?`	`number`	-
`parameters.iqlParams.qlQuery?`	`string`	-
`parameters.iqlParams.resultsPerPage?`	`number`	-
`parameters.iqlSearch?`	`boolean`	-
`parameters.objectSchemaId?`	`number`	-
`parameters.qlQueryParams?`	{ `asc?`: `number`; `attributesToDisplay?`: { `attributesToDisplayIds?`: `number`[]; }; `includeAttributes?`: `boolean`; `iql?`: `string`; `objectId?`: `number`; `objectSchemaId?`: `number`; `objectTypeId?`: `number`; `orderByTypeAttrId?`: `number`; `page?`: `number`; `qlQuery?`: `string`; `resultsPerPage?`: `number`; }	-
`parameters.qlQueryParams.asc?`	`number`	-
`parameters.qlQueryParams.attributesToDisplay?`	{ `attributesToDisplayIds?`: `number`[]; }	-
`parameters.qlQueryParams.attributesToDisplay.attributesToDisplayIds?`	`number`[]	-
`parameters.qlQueryParams.includeAttributes?`	`boolean`	-
`parameters.qlQueryParams.iql?`	`string`	-
`parameters.qlQueryParams.objectId?`	`number`	-
`parameters.qlQueryParams.objectSchemaId?`	`number`	-
`parameters.qlQueryParams.objectTypeId?`	`number`	-
`parameters.qlQueryParams.orderByTypeAttrId?`	`number`	-
`parameters.qlQueryParams.page?`	`number`	-
`parameters.qlQueryParams.qlQuery?`	`string`	-
`parameters.qlQueryParams.resultsPerPage?`	`number`	-
`parameters.qlQuerySearch?`	`boolean`	-
`parameters.typeId?`	`string`	The object type id to archive.
`options?`	`RequestOptions`	-

Returns

objects.archiveObjectsByKeys

archiveObjectsByKeys: (parameters, options?) => Promise<{
[key: string]: unknown;
  actor?: string;
  category?: string;
  currentStep?: number;
  currentStepTotalWorkUnits?: number;
  currentWorkDescription?: string;
  currentWorkUnits?: number;
  estimatedFinishDate?: Date;
  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`	{ `body?`: `string`[]; }	-
`parameters.body?`	`string`[]	The keys of the objects to archive.
`options?`	`RequestOptions`	-

Returns

objects.bulkSetObjectImportSource

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

Parameters

Parameter	Type
`parameters`	{ `body?`: `Record`<`string`, `any`>; }
`parameters.body?`	`Record`<`string`, `any`>
`options?`	`RequestOptions`

Returns

Promise<void>

objects.clearObjectImportSource

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

Parameters

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

Returns

Promise<void>

objects.createObject

createObject: (parameters, options?) => Promise<AssetObject>;

Parameters

Parameter	Type
`parameters`	{ `attributes`: `object`[]; `objectTypeId`: `number`; }
`parameters.attributes`	`object`[]
`parameters.objectTypeId?`	`number`
`options?`	`RequestOptions`

Returns

Promise<AssetObject>

objects.deleteObject

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

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The ID or object key of the object to delete.
`options?`	`RequestOptions`	-

Returns

Promise<AssetObject>

objects.findObject

findObject: (parameters, options?) => Promise<{
[key: string]: unknown;
  abstractObjectType?: boolean;
  conversionPossible?: boolean;
  filters?: object[];
  inheritanceTree?: {
   [key: string]: unknown;
     parentObjectTypeIdsInclSelf?: Record<string, any>;
  };
  iql?: string;
  iqlSearchResult?: boolean;
  matchedFilterValues?: ObjectAttribute[];
  objectEntries?: AssetObject[];
  objectTypeAttributes?: object[];
  objectTypeId?: number;
  objectTypeIsInherited?: boolean;
  orderAscending?: boolean;
  orderByTypeAttrId?: number;
  orderWay?: string;
  pageNumber?: number;
  pageObjectSize?: number;
  pageSize?: number;
  qlQuery?: string;
  qlQuerySearchResult?: boolean;
  startIndex?: number;
  toIndex?: number;
  totalFilterCount?: number;
}>;

Parameters

Parameter	Type
`parameters`	{ `asc?`: `number`; `attributesToDisplay?`: { `attributesToDisplayIds?`: `number`[]; }; `includeAttributes?`: `boolean`; `iql?`: `string`; `objectId?`: `number`; `objectSchemaId?`: `number`; `objectTypeId?`: `number`; `orderByTypeAttrId?`: `number`; `page?`: `number`; `qlQuery?`: `string`; `resultsPerPage?`: `number`; }
`parameters.asc?`	`number`
`parameters.attributesToDisplay?`	{ `attributesToDisplayIds?`: `number`[]; }
`parameters.attributesToDisplay.attributesToDisplayIds?`	`number`[]
`parameters.includeAttributes?`	`boolean`
`parameters.iql?`	`string`
`parameters.objectId?`	`number`
`parameters.objectSchemaId?`	`number`
`parameters.objectTypeId?`	`number`
`parameters.orderByTypeAttrId?`	`number`
`parameters.page?`	`number`
`parameters.qlQuery?`	`string`
`parameters.resultsPerPage?`	`number`
`options?`	`RequestOptions`

Returns

objects.findObjectAttributes

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

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The ID or object key of the object to load.
`options?`	`RequestOptions`	-

Returns

Promise<ObjectAttribute[]>

objects.findObjectHistory

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

Parameters

Parameter	Type	Description
`parameters`	{ `abbreviate?`: `string`; `asc?`: `boolean`; `id`: `string`; `orderAsc?`: `string`; }	-
`parameters.abbreviate?`	`string`	Should the values returned in the history entry be abbreviated.
`parameters.asc?`	`boolean`	-
`parameters.id?`	`string`	The ID or object key of the object to load.
`parameters.orderAsc?`	`string`	Should the history be retrieved in ascending order. Uses the Jira setting for sort order as its default value.
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

objects.findObjectReferenceInfo

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

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The ID or object key of the object to load.
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

objects.getArchivedObjects

getArchivedObjects: (parameters?, options?) => Promise<{
[key: string]: unknown;
  count?: number;
  limit?: number;
  offset?: number;
  results?: object[];
  total?: number;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `archivedBy?`: `string`; `archivedFromDate?`: `string`; `archivedToDate?`: `string`; `limit?`: `string`; `objectSchemaId?`: `string`; `objectTypeIds?`: `string`; `offset?`: `string`; }	-
`parameters.archivedBy?`	`string`	A list of users that archived the objects. Optional. If not set, all users will be searched for.
`parameters.archivedFromDate?`	`string`	Timestamp in ISO Offset Date Time format e.g. 2021-12-03T10:15:30+01:00. Only objects archived at or after this time will be displayed. Optional.
`parameters.archivedToDate?`	`string`	Timestamp in ISO Offset Date Time format e.g. 2021-12-03T10:15:30+01:00. Only objects archived before this time will be displayed. Must be after archivedFromDate, if both are set. Optional.
`parameters.limit?`	`string`	The maximum number of objects to return. Optional.
`parameters.objectSchemaId?`	`string`	The id of the object schema to search for.
`parameters.objectTypeIds?`	`string`	A list of object type ids to search for. Optional. If not set, all object types within the schema will be searched for.
`parameters.offset?`	`string`	The offset of the first object to return. Optional.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; count?: number; limit?: number; offset?: number; results?: object[]; total?: number; }>

objects.getObjectImportSource

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

Parameters

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

Returns

Promise<void>

objects.loadObject

loadObject: (parameters, options?) => Promise<AssetObject>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; `includeAttributes?`: `string`; `includeExtendedInfo?`: `string`; `xoauth_requestor_id?`: `string`; }	-
`parameters.id`	`string`	The ID or object key of the object to load.
`parameters.includeAttributes?`	`string`	Should the attributes be included in the response.
`parameters.includeExtendedInfo?`	`string`	Should the extended info be included in the response.
`parameters.xoauth_requestor_id?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<AssetObject>

objects.restoreObject

restoreObject: (parameters, options?) => Promise<AssetObject>;

Parameters

Parameter	Type	Description
`parameters`	{ `objectIdentifier`: `string`; }	-
`parameters.objectIdentifier`	`string`	The object identifier to restore.
`options?`	`RequestOptions`	-

Returns

Promise<AssetObject>

objects.restoreObjectsByFilter

restoreObjectsByFilter: (parameters, options?) => Promise<{
[key: string]: unknown;
  actor?: string;
  category?: string;
  currentStep?: number;
  currentStepTotalWorkUnits?: number;
  currentWorkDescription?: string;
  currentWorkUnits?: number;
  estimatedFinishDate?: Date;
  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`	{ `archivedBy?`: `string`; `archivedFromDate?`: `string`; `archivedToDate?`: `string`; `objectSchemaId?`: `string`; `objectTypeIds?`: `string`; }	-
`parameters.archivedBy?`	`string`	A list of users that archived the objects. Optional. If not set, all users will be searched for.
`parameters.archivedFromDate?`	`string`	Timestamp in ISO Offset Date Time format e.g. 2021-12-03T10:15:30+01:00. Only objects archived at or after this time will be displayed. Optional.
`parameters.archivedToDate?`	`string`	Timestamp in ISO Offset Date Time format e.g. 2021-12-03T10:15:30+01:00. Only objects archived before this time will be displayed. Must be after archivedFromDate, if both are set. Optional.
`parameters.objectSchemaId?`	`string`	The id of the object schema to search for.
`parameters.objectTypeIds?`	`string`	A list of object type ids to search for. Optional. If not set, all object types within the schema will be searched for.
`options?`	`RequestOptions`	-

Returns

objects.restoreObjectsByIds

restoreObjectsByIds: (parameters, options?) => Promise<{
[key: string]: unknown;
  actor?: string;
  category?: string;
  currentStep?: number;
  currentStepTotalWorkUnits?: number;
  currentWorkDescription?: string;
  currentWorkUnits?: number;
  estimatedFinishDate?: Date;
  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
`parameters`	{ `body?`: `number`[]; }
`parameters.body?`	`number`[]
`options?`	`RequestOptions`

Returns

objects.restoreObjectsByKeys

restoreObjectsByKeys: (parameters, options?) => Promise<{
[key: string]: unknown;
  actor?: string;
  category?: string;
  currentStep?: number;
  currentStepTotalWorkUnits?: number;
  currentWorkDescription?: string;
  currentWorkUnits?: number;
  estimatedFinishDate?: Date;
  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
`parameters`	{ `body?`: `string`[]; }
`parameters.body?`	`string`[]
`options?`	`RequestOptions`

Returns

objects.updateObject

updateObject: (parameters, options?) => Promise<AssetObject>;

Parameters

Parameter	Type	Description
`parameters`	{ `attributes`: `object`[]; `id`: `string`; `objectTypeId`: `number`; }	-
`parameters.attributes`	`object`[]	-
`parameters.id?`	`string`	The ID or object key of the object to update.
`parameters.objectTypeId?`	`number`	-
`options?`	`RequestOptions`	-

Returns

Promise<AssetObject>

objectSchemas

objectSchemas: object;

objectSchemas.createSchema

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

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; archivedObjectCount?: number; created?: Date; description?: string; id?: number; name?: string; objectCount?: number; objectSchemaKey?: string; objectTypeCount?: number; status?: string; updated?: Date; }>

objectSchemas.deleteSchema

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

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The ID of the object schema to delete
`options?`	`RequestOptions`	-

Returns

objectSchemas.findObjectTypeFlatList

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

Parameters

Parameter	Type	Description
`parameters`	{ `exclude?`: `string`; `id`: `string`; `query?`: `string`; `role?`: `string`; }	-
`parameters.exclude?`	`string`	Exclude object types with this name
`parameters.id?`	`string`	The ID of the object schema to retrieve object types from
`parameters.query?`	`string`	Query to filter on available object types
`parameters.role?`	`string`	The Object Type role to filter the list of object types. Valid values: `OBJECT_TYPE_USER`, `OBJECT_TYPE_DEVELOPER`, `OBJECT_TYPE_MANAGER`
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

objectSchemas.findSchemas

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

Parameters

Parameter	Type	Description
`parameters?`	{ `query?`: `string`; `xoauth_requestor_id?`: `string`; }	-
`parameters.query?`	`string`	Query to filter on available object schemas
`parameters.xoauth_requestor_id?`	`string`	-
`options?`	`RequestOptions`	-

Returns

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

objectSchemas.loadSchema

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

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The ID of the object schema to retrieve
`options?`	`RequestOptions`	-

Returns

objectSchemas.updateSchema

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

Parameters

Parameter	Type
`parameters`	{ `body?`: { `archivedObjectCount?`: `number`; `created?`: `unknown`; `description?`: `string`; `id?`: `number`; `name?`: `string`; `objectCount?`: `number`; `objectSchemaKey?`: `string`; `objectTypeCount?`: `number`; `status?`: `string`; `updated?`: `unknown`; }; `id`: `string`; }
`parameters.body?`	{ `archivedObjectCount?`: `number`; `created?`: `unknown`; `description?`: `string`; `id?`: `number`; `name?`: `string`; `objectCount?`: `number`; `objectSchemaKey?`: `string`; `objectTypeCount?`: `number`; `status?`: `string`; `updated?`: `unknown`; }
`parameters.body.archivedObjectCount?`	`number`
`parameters.body.created?`	`unknown`
`parameters.body.description?`	`string`
`parameters.body.id?`	`number`
`parameters.body.name?`	`string`
`parameters.body.objectCount?`	`number`
`parameters.body.objectSchemaKey?`	`string`
`parameters.body.objectTypeCount?`	`number`
`parameters.body.status?`	`string`
`parameters.body.updated?`	`unknown`
`parameters.id?`	`string`
`options?`	`RequestOptions`

Returns

objectTypeAttributes

objectTypeAttributes: object;

objectTypeAttributes.deleteObjectTypeAttribute

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

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The ID of the attribute to delete.
`options?`	`RequestOptions`	-

Returns

Promise<void>

objectTypeAttributes.storeObjectTypeAttribute

storeObjectTypeAttribute: (parameters, options?) => Promise<{
[key: string]: unknown;
  additionalValue?: string;
  confluenceAddValue?: {
   [key: string]: unknown;
     error?: boolean;
     key?: string;
     name?: string;
  };
  confluenceTypeValue?: {
   [key: string]: unknown;
     error?: boolean;
     id?: string;
     name?: string;
     uri?: string;
  };
  defaultType?: {
   [key: string]: unknown;
     id?: number;
     name?: string;
  };
  description?: string;
  editable?: boolean;
  hidden?: boolean;
  id?: number;
  includeChildObjectTypes?: boolean;
  indexed?: boolean;
  iql?: string;
  label?: boolean;
  maximumCardinality?: number;
  minimumCardinality?: number;
  name?: string;
  objectAttributeExists?: boolean;
  objectType?: {
   [key: string]: unknown;
     abstractObjectType?: boolean;
     created?: Date;
     description?: string;
     icon?: {
      [key: string]: unknown;
        after?: string;
        expand?: string;
        id?: number;
        name?: string;
        position?: string;
        project?: string;
        url16?: string;
        url48?: string;
     };
     id?: number;
     inherited?: boolean;
     name?: string;
     objectCount?: number;
     objectSchemaId?: number;
     parentObjectTypeId?: number;
     parentObjectTypeInherited?: boolean;
     position?: number;
     type?: number;
     updated?: Date;
  };
  options?: string;
  position?: number;
  qlQuery?: string;
  referenceObjectType?: {
   [key: string]: unknown;
     abstractObjectType?: boolean;
     created?: Date;
     description?: string;
     icon?: {
      [key: string]: unknown;
        after?: string;
        expand?: string;
        id?: number;
        name?: string;
        position?: string;
        project?: string;
        url16?: string;
        url48?: string;
     };
     id?: number;
     inherited?: boolean;
     name?: string;
     objectCount?: number;
     objectSchemaId?: number;
     parentObjectTypeId?: number;
     parentObjectTypeInherited?: boolean;
     position?: number;
     type?: number;
     updated?: Date;
  };
  referenceObjectTypeId?: number;
  referenceType?: {
   [key: string]: unknown;
     after?: string;
     color?: string;
     description?: string;
     expand?: string;
     id?: number;
     name?: string;
     objectSchemaId?: number;
     position?: string;
     project?: string;
     removable?: boolean;
     url16?: string;
  };
  regexValidation?: string;
  removable?: boolean;
  sortable?: boolean;
  suffix?: string;
  summable?: boolean;
  system?: boolean;
  type?: number;
  typeValue?: string;
  typeValueMulti?: string[];
  uniqueAttribute?: boolean;
  versionTypeValue?: {
   [key: string]: unknown;
     avatarUrl?: string;
     id?: number;
     key?: string;
     name?: string;
     url?: string;
  };
  versionTypeValues?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `additionalValue?`: `string`; `after?`: `string`; `defaultTypeId?`: `number`; `description?`: `string`; `expand?`: `string`; `hidden?`: `string`; `id?`: `number`; `includeChildObjectTypes?`: `string`; `indexed?`: `string`; `iql?`: `string`; `label?`: `string`; `maximumCardinality?`: `number`; `minimumCardinality?`: `number`; `name?`: `string`; `objectTypeId`: `string`; `options?`: `string`; `position?`: `string`; `project?`: `string`; `qlQuery?`: `string`; `regexValidation?`: `string`; `removeExcessCardinality?`: `boolean`; `suffix?`: `string`; `summable?`: `string`; `type`: `number`; `typeValue?`: `string`; `typeValueMulti?`: `string`[]; `uniqueAttribute?`: `string`; }	-
`parameters.additionalValue?`	`string`	-
`parameters.after?`	`string`	-
`parameters.defaultTypeId?`	`number`	-
`parameters.description?`	`string`	-
`parameters.expand?`	`string`	-
`parameters.hidden?`	`string`	-
`parameters.id?`	`number`	-
`parameters.includeChildObjectTypes?`	`string`	-
`parameters.indexed?`	`string`	-
`parameters.iql?`	`string`	-
`parameters.label?`	`string`	-
`parameters.maximumCardinality?`	`number`	-
`parameters.minimumCardinality?`	`number`	-
`parameters.name?`	`string`	-
`parameters.objectTypeId?`	`string`	The ID of the object type to store the attribute for.
`parameters.options?`	`string`	-
`parameters.position?`	`string`	-
`parameters.project?`	`string`	-
`parameters.qlQuery?`	`string`	-
`parameters.regexValidation?`	`string`	-
`parameters.removeExcessCardinality?`	`boolean`	-
`parameters.suffix?`	`string`	-
`parameters.summable?`	`string`	-
`parameters.type?`	`number`	-
`parameters.typeValue?`	`string`	-
`parameters.typeValueMulti?`	`string`[]	-
`parameters.uniqueAttribute?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; additionalValue?: string; confluenceAddValue?: { [key: string]: unknown; error?: boolean; key?: string; name?: string; }; confluenceTypeValue?: { [key: string]: unknown; error?: boolean; id?: string; name?: string; uri?: string; }; defaultType?: { [key: string]: unknown; id?: number; name?: string; }; description?: string; editable?: boolean; hidden?: boolean; id?: number; includeChildObjectTypes?: boolean; indexed?: boolean; iql?: string; label?: boolean; maximumCardinality?: number; minimumCardinality?: number; name?: string; objectAttributeExists?: boolean; objectType?: { [key: string]: unknown; abstractObjectType?: boolean; created?: Date; description?: string; icon?: { [key: string]: unknown; after?: string; expand?: string; id?: number; name?: string; position?: string; project?: string; url16?: string; url48?: string; }; id?: number; inherited?: boolean; name?: string; objectCount?: number; objectSchemaId?: number; parentObjectTypeId?: number; parentObjectTypeInherited?: boolean; position?: number; type?: number; updated?: Date; }; options?: string; position?: number; qlQuery?: string; referenceObjectType?: { [key: string]: unknown; abstractObjectType?: boolean; created?: Date; description?: string; icon?: { [key: string]: unknown; after?: string; expand?: string; id?: number; name?: string; position?: string; project?: string; url16?: string; url48?: string; }; id?: number; inherited?: boolean; name?: string; objectCount?: number; objectSchemaId?: number; parentObjectTypeId?: number; parentObjectTypeInherited?: boolean; position?: number; type?: number; updated?: Date; }; referenceObjectTypeId?: number; referenceType?: { [key: string]: unknown; after?: string; color?: string; description?: string; expand?: string; id?: number; name?: string; objectSchemaId?: number; position?: string; project?: string; removable?: boolean; url16?: string; }; regexValidation?: string; removable?: boolean; sortable?: boolean; suffix?: string; summable?: boolean; system?: boolean; type?: number; typeValue?: string; typeValueMulti?: string[]; uniqueAttribute?: boolean; versionTypeValue?: { [key: string]: unknown; avatarUrl?: string; id?: number; key?: string; name?: string; url?: string; }; versionTypeValues?: object[]; }>

objectTypeAttributes.updateObjectTypeAttribute

updateObjectTypeAttribute: (parameters, options?) => Promise<{
[key: string]: unknown;
  additionalValue?: string;
  confluenceAddValue?: {
   [key: string]: unknown;
     error?: boolean;
     key?: string;
     name?: string;
  };
  confluenceTypeValue?: {
   [key: string]: unknown;
     error?: boolean;
     id?: string;
     name?: string;
     uri?: string;
  };
  defaultType?: {
   [key: string]: unknown;
     id?: number;
     name?: string;
  };
  description?: string;
  editable?: boolean;
  hidden?: boolean;
  id?: number;
  includeChildObjectTypes?: boolean;
  indexed?: boolean;
  iql?: string;
  label?: boolean;
  maximumCardinality?: number;
  minimumCardinality?: number;
  name?: string;
  objectAttributeExists?: boolean;
  objectType?: {
   [key: string]: unknown;
     abstractObjectType?: boolean;
     created?: Date;
     description?: string;
     icon?: {
      [key: string]: unknown;
        after?: string;
        expand?: string;
        id?: number;
        name?: string;
        position?: string;
        project?: string;
        url16?: string;
        url48?: string;
     };
     id?: number;
     inherited?: boolean;
     name?: string;
     objectCount?: number;
     objectSchemaId?: number;
     parentObjectTypeId?: number;
     parentObjectTypeInherited?: boolean;
     position?: number;
     type?: number;
     updated?: Date;
  };
  options?: string;
  position?: number;
  qlQuery?: string;
  referenceObjectType?: {
   [key: string]: unknown;
     abstractObjectType?: boolean;
     created?: Date;
     description?: string;
     icon?: {
      [key: string]: unknown;
        after?: string;
        expand?: string;
        id?: number;
        name?: string;
        position?: string;
        project?: string;
        url16?: string;
        url48?: string;
     };
     id?: number;
     inherited?: boolean;
     name?: string;
     objectCount?: number;
     objectSchemaId?: number;
     parentObjectTypeId?: number;
     parentObjectTypeInherited?: boolean;
     position?: number;
     type?: number;
     updated?: Date;
  };
  referenceObjectTypeId?: number;
  referenceType?: {
   [key: string]: unknown;
     after?: string;
     color?: string;
     description?: string;
     expand?: string;
     id?: number;
     name?: string;
     objectSchemaId?: number;
     position?: string;
     project?: string;
     removable?: boolean;
     url16?: string;
  };
  regexValidation?: string;
  removable?: boolean;
  sortable?: boolean;
  suffix?: string;
  summable?: boolean;
  system?: boolean;
  type?: number;
  typeValue?: string;
  typeValueMulti?: string[];
  uniqueAttribute?: boolean;
  versionTypeValue?: {
   [key: string]: unknown;
     avatarUrl?: string;
     id?: number;
     key?: string;
     name?: string;
     url?: string;
  };
  versionTypeValues?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `body?`: { `additionalValue?`: `string`; `after?`: `string`; `defaultTypeId?`: `number`; `description?`: `string`; `expand?`: `string`; `hidden?`: `string`; `id?`: `number`; `includeChildObjectTypes?`: `string`; `indexed?`: `string`; `iql?`: `string`; `label?`: `string`; `maximumCardinality?`: `number`; `minimumCardinality?`: `number`; `name?`: `string`; `options?`: `string`; `position?`: `string`; `project?`: `string`; `qlQuery?`: `string`; `regexValidation?`: `string`; `removeExcessCardinality?`: `boolean`; `suffix?`: `string`; `summable?`: `string`; `type`: `number`; `typeValue?`: `string`; `typeValueMulti?`: `string`[]; `uniqueAttribute?`: `string`; }; `id`: `string`; `objectTypeId`: `string`; }	-
`parameters.body?`	{ `additionalValue?`: `string`; `after?`: `string`; `defaultTypeId?`: `number`; `description?`: `string`; `expand?`: `string`; `hidden?`: `string`; `id?`: `number`; `includeChildObjectTypes?`: `string`; `indexed?`: `string`; `iql?`: `string`; `label?`: `string`; `maximumCardinality?`: `number`; `minimumCardinality?`: `number`; `name?`: `string`; `options?`: `string`; `position?`: `string`; `project?`: `string`; `qlQuery?`: `string`; `regexValidation?`: `string`; `removeExcessCardinality?`: `boolean`; `suffix?`: `string`; `summable?`: `string`; `type`: `number`; `typeValue?`: `string`; `typeValueMulti?`: `string`[]; `uniqueAttribute?`: `string`; }	-
`parameters.body.additionalValue?`	`string`	-
`parameters.body.after?`	`string`	-
`parameters.body.defaultTypeId?`	`number`	-
`parameters.body.description?`	`string`	-
`parameters.body.expand?`	`string`	-
`parameters.body.hidden?`	`string`	-
`parameters.body.id?`	`number`	-
`parameters.body.includeChildObjectTypes?`	`string`	-
`parameters.body.indexed?`	`string`	-
`parameters.body.iql?`	`string`	-
`parameters.body.label?`	`string`	-
`parameters.body.maximumCardinality?`	`number`	-
`parameters.body.minimumCardinality?`	`number`	-
`parameters.body.name?`	`string`	-
`parameters.body.options?`	`string`	-
`parameters.body.position?`	`string`	-
`parameters.body.project?`	`string`	-
`parameters.body.qlQuery?`	`string`	-
`parameters.body.regexValidation?`	`string`	-
`parameters.body.removeExcessCardinality?`	`boolean`	-
`parameters.body.suffix?`	`string`	-
`parameters.body.summable?`	`string`	-
`parameters.body.type?`	`number`	-
`parameters.body.typeValue?`	`string`	-
`parameters.body.typeValueMulti?`	`string`[]	-
`parameters.body.uniqueAttribute?`	`string`	-
`parameters.id?`	`string`	The ID of the attribute to update.
`parameters.objectTypeId?`	`string`	The ID of the object type to update the attribute for.
`options?`	`RequestOptions`	-

Returns

objectTypes

objectTypes: object;

objectTypes.changeOrderObjectType

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

Parameters

Parameter	Type	Description
`parameters`	{ `affectedId`: `string`; `position?`: `number`; `toObjectTypeId?`: `number`; }	-
`parameters.affectedId`	`string`	The ID of the object type to change the position of.
`parameters.position?`	`number`	-
`parameters.toObjectTypeId?`	`number`	-
`options?`	`RequestOptions`	-

Returns

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

objectTypes.createObjectType

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

Parameters

Parameter	Type
`parameters`	{ `abstractObjectType?`: `boolean`; `description?`: `string`; `iconId?`: `number`; `id?`: `number`; `inherited?`: `boolean`; `name?`: `string`; `objectSchemaId?`: `number`; `parentObjectTypeId?`: `number`; }
`parameters.abstractObjectType?`	`boolean`
`parameters.description?`	`string`
`parameters.iconId?`	`number`
`parameters.id?`	`number`
`parameters.inherited?`	`boolean`
`parameters.name?`	`string`
`parameters.objectSchemaId?`	`number`
`parameters.parentObjectTypeId?`	`number`
`options?`	`RequestOptions`

Returns

objectTypes.deleteObjectType

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

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The ID of the object type to delete.
`options?`	`RequestOptions`	-

Returns

objectTypes.findObjectTypeAttributes

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

Parameters

Parameter	Type	Description
`parameters`	{ `excludeParentAttributes?`: `string`; `id`: `string`; `includeChildren?`: `string`; `includeValueExist?`: `string`; `onlyValueEditable?`: `string`; `orderByName?`: `string`; `orderByRequired?`: `string`; `query?`: `string`; }	-
`parameters.excludeParentAttributes?`	`string`	Should the response exclude parent attributes.
`parameters.id?`	`string`	The ID of the object type to retrieve attributes for.
`parameters.includeChildren?`	`string`	Should the response include child attributes.
`parameters.includeValueExist?`	`string`	Should the response only include attributes where attribute values exists.
`parameters.onlyValueEditable?`	`string`	Should the response only include attributes where only the value is editable.
`parameters.orderByName?`	`string`	Should the response be ordered by name.
`parameters.orderByRequired?`	`string`	Should the response be ordered by the number of required attributes.
`parameters.query?`	`string`	Filter attributes that start with the query.
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

objectTypes.loadObjectType

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

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The ID of the object type to retrieve.
`options?`	`RequestOptions`	-

Returns

objectTypes.updateObjectType

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

Parameters

Parameter	Type	Description
`parameters`	{ `body?`: { `abstractObjectType?`: `boolean`; `description?`: `string`; `iconId?`: `number`; `id?`: `number`; `inherited?`: `boolean`; `name?`: `string`; `objectSchemaId?`: `number`; `parentObjectTypeId?`: `number`; }; `id`: `string`; }	-
`parameters.body?`	{ `abstractObjectType?`: `boolean`; `description?`: `string`; `iconId?`: `number`; `id?`: `number`; `inherited?`: `boolean`; `name?`: `string`; `objectSchemaId?`: `number`; `parentObjectTypeId?`: `number`; }	-
`parameters.body.abstractObjectType?`	`boolean`	-
`parameters.body.description?`	`string`	-
`parameters.body.iconId?`	`number`	-
`parameters.body.id?`	`number`	-
`parameters.body.inherited?`	`boolean`	-
`parameters.body.name?`	`string`	-
`parameters.body.objectSchemaId?`	`number`	-
`parameters.body.parentObjectTypeId?`	`number`	-
`parameters.id?`	`string`	The ID of the object type to update.
`options?`	`RequestOptions`	-

Returns

progress

progress: object;

progress.getProgressForCategoryAndResourceId

getProgressForCategoryAndResourceId: (parameters, options?) => Promise<{
[key: string]: unknown;
  actor?: string;
  category?: string;
  currentStep?: number;
  currentStepTotalWorkUnits?: number;
  currentWorkDescription?: string;
  currentWorkUnits?: number;
  estimatedFinishDate?: Date;
  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`	{ `category`: `string`; `resourceid`: `string`; }	-
`parameters.category`	`string`	Specifies the type of ongoing task. Possible values include: `imports, insight-reindex, freetext-reindex, cache-query, async-task`
`parameters.resourceid?`	`string`	Specifies the id of the ongoing task.
`options?`	`RequestOptions`	-

Returns

qrCode

qrCode: object;

qrCode.getObjectQrCode

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

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; `size?`: `string`; }	-
`parameters.id`	`string`	The ID of the object to retrieve the QR code for.
`parameters.size?`	`string`	The size of the QR code.
`options?`	`RequestOptions`	-

Returns

Promise<ArrayBuffer | ArrayBufferView<ArrayBufferLike>>

statusTypes

statusTypes: object;

statusTypes.deleteStatusType

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

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The ID of the status type to delete
`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 this parameter is supplied, statuses for the given object schema will be returned. Otherwise all global statuses will be returned.
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

statusTypes.getStatusType

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

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The ID of the status type to retrieve
`options?`	`RequestOptions`	-

Returns

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

statusTypes.storeStatusType

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

Parameters

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

Returns

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

statusTypes.updateStatusType

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

Parameters

Parameter	Type	Description
`parameters`	{ `body?`: { `category?`: `number`; `description?`: `string`; `id?`: `number`; `name?`: `string`; `objectSchemaId?`: `number`; }; `id`: `string`; }	-
`parameters.body?`	{ `category?`: `number`; `description?`: `string`; `id?`: `number`; `name?`: `string`; `objectSchemaId?`: `number`; }	-
`parameters.body.category?`	`number`	-
`parameters.body.description?`	`string`	-
`parameters.body.id?`	`number`	-
`parameters.body.name?`	`string`	-
`parameters.body.objectSchemaId?`	`number`	-
`parameters.id?`	`string`	The ID of the status type to update
`options?`	`RequestOptions`	-

Returns

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

Function: createAssetsServerClient() ​

Parameters ​

Returns ​

analytics ​

analytics.getSchemaAnalytics ​

Parameters ​

Returns ​

aql ​

aql.findObjects ​

Parameters ​

Returns ​

attachments ​

attachments.addAttachments ​

Parameters ​

Returns ​

attachments.deleteAttachment ​

Parameters ​

Returns ​

attachments.getAttachments ​

Parameters ​

Returns ​

comments ​

comments.createComment ​

Parameters ​

Returns ​

comments.getComments ​

Parameters ​

Returns ​

connectedTickets ​

connectedTickets.findObjectTickets ​

Parameters ​

Returns ​

icons ​

icons.findGlobalIcons ​

Parameters ​

Returns ​

icons.findIcons ​

Parameters ​

Returns ​

icons.getIcon ​

Parameters ​

Returns ​

indexConfiguration ​

indexConfiguration.checkIndexIntegrity ​

Parameters ​

Returns ​

indexConfiguration.getIndexPath ​

Parameters ​

Returns ​

indexConfiguration.persistIndexToFile ​

Parameters ​

Returns ​

indexConfiguration.startReindexCurrentNode ​

Parameters ​

Returns ​

indexConfiguration.startReindexInsight ​

Parameters ​

Returns ​

objectAttributes ​

objectAttributes.createObjectAttribute ​

Parameters ​

Returns ​

objects ​

objects.archiveObject ​

Parameters ​

Returns ​

objects.archiveObjectsByFilter ​

Parameters ​

Returns ​

objects.archiveObjectsByKeys ​

Parameters ​

Returns ​

objects.bulkSetObjectImportSource ​

Parameters ​

Returns ​

objects.clearObjectImportSource ​

Parameters ​

Returns ​

objects.createObject ​

Parameters ​

Function: createAssetsServerClient()

Parameters

Returns

analytics

analytics.getSchemaAnalytics

Parameters

Returns

aql

aql.findObjects

Parameters

Returns

attachments

attachments.addAttachments

Parameters

Returns

attachments.deleteAttachment

Parameters

Returns

attachments.getAttachments

Parameters

Returns

comments

comments.createComment

Parameters

Returns

comments.getComments

Parameters

Returns

connectedTickets

connectedTickets.findObjectTickets

Parameters

Returns

icons

icons.findGlobalIcons

Parameters

Returns

icons.findIcons

Parameters

Returns

icons.getIcon

Parameters

Returns

indexConfiguration

indexConfiguration.checkIndexIntegrity

Parameters

Returns

indexConfiguration.getIndexPath

Parameters

Returns

indexConfiguration.persistIndexToFile

Parameters

Returns

indexConfiguration.startReindexCurrentNode

Parameters

Returns

indexConfiguration.startReindexInsight

Parameters

Returns

objectAttributes

objectAttributes.createObjectAttribute

Parameters

Returns

objects

objects.archiveObject

Parameters

Returns

objects.archiveObjectsByFilter

Parameters

Returns

objects.archiveObjectsByKeys

Parameters

Returns

objects.bulkSetObjectImportSource

Parameters

Returns

objects.clearObjectImportSource

Parameters

Returns

objects.createObject

Parameters