Function: createServiceDeskClient()

function createServiceDeskClient(clientConfig): object;

Defined in: src/serviceDesk/createServiceDeskClient.ts:99

Parameters

Parameter	Type
`clientConfig`	\| `ClientConfig` \| `Client`

Returns

object

assets

assets: object;

assets.getAssetsWorkspaces

getAssetsWorkspaces: (parameters?, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `limit?`: `number`; `start?`: `number`; }	-
`parameters.limit?`	`number`	The maximum number of workspace IDs to return per page. Default: 50 See the Pagination section for more details.
`parameters.start?`	`number`	The starting index of the returned workspace IDs. Base index: 0 See the Pagination section for more details.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; base?: string; context?: string; next?: string; prev?: string; self?: string; }; isLastPage?: boolean; limit?: number; size?: number; start?: number; values?: object[]; }>

assets.getInsightWorkspaces

getInsightWorkspaces: (parameters?, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type
`parameters?`	{ `limit?`: `number`; `start?`: `number`; }
`parameters.limit?`	`number`
`parameters.start?`	`number`
`options?`	`RequestOptions`

Returns

Deprecated

This endpoint is deprecated, please use /assets/workspace/. In this library that is getAssetsWorkspaces.

customer

customer: object;

customer.createCustomer

createCustomer: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     avatarUrls?: Record<string, string>;
     jiraRest?: string;
     self?: string;
  };
  accountId?: string;
  active?: boolean;
  displayName?: string;
  emailAddress?: string;
  key?: string;
  name?: string;
  timeZone?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `displayName?`: `string`; `email?`: `string`; `fullName?`: `string`; `strictConflictStatusCode?`: `boolean`; }	-
`parameters.displayName?`	`string`	Customer's name for display in the UI.
`parameters.email?`	`string`	Customer's email address.
`parameters.fullName?`	`string`	Deprecated, please use 'displayName'.
`parameters.strictConflictStatusCode?`	`boolean`	Optional boolean flag to return 409 Conflict status code for duplicate customer creation request
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; avatarUrls?: Record<string, string>; jiraRest?: string; self?: string; }; accountId?: string; active?: boolean; displayName?: string; emailAddress?: string; key?: string; name?: string; timeZone?: string; }>

customer.createCustomerSkippingPermissionCheck

createCustomerSkippingPermissionCheck: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     avatarUrls?: Record<string, string>;
     jiraRest?: string;
     self?: string;
  };
  accountId?: string;
  active?: boolean;
  displayName?: string;
  emailAddress?: string;
  key?: string;
  name?: string;
  timeZone?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `displayName?`: `string`; `email?`: `string`; `fullName?`: `string`; `strictConflictStatusCode?`: `boolean`; }	-
`parameters.displayName?`	`string`	Customer's name for display in the UI.
`parameters.email?`	`string`	Customer's email address.
`parameters.fullName?`	`string`	Deprecated, please use 'displayName'.
`parameters.strictConflictStatusCode?`	`boolean`	Optional boolean flag; when `true`, returns 409 Conflict for duplicate email instead of the default 400.
`options?`	`RequestOptions`	-

Returns

customer.revokePortalOnlyAccessForUser

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

Parameters

Parameter	Type	Description
`parameters`	{ `accountId`: `string`; }	-
`parameters.accountId`	`string`	The account ID of the user, which uniquely identifies the portal-only account. For example, qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b.
`options?`	`RequestOptions`	-

Returns

Promise<void>

info

info: object;

info.getInfo

getInfo: (options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  buildChangeSet?: string;
  buildDate?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  isLicensedForUse?: boolean;
  platformVersion?: string;
  version?: string;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; buildChangeSet?: string; buildDate?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; isLicensedForUse?: boolean; platformVersion?: string; version?: string; }>

knowledgebase

knowledgebase: object;

knowledgebase.getArticles

getArticles: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `cursor?`: `string`; `highlight`: `boolean`; `limit?`: `number`; `prev?`: `boolean`; `query`: `string`; `start?`: `number`; }	-
`parameters.cursor?`	`string`	Pointer to a set of search results, returned as part of the next or prev URL from the previous search call.
`parameters.highlight?`	`boolean`	If set to true matching query term in the title and excerpt will be highlighted using the `@@@hl@@@term@@@endhl@@@` syntax. Default: false.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.prev?`	`boolean`	Should navigate to the previous page. Defaulted to false. Set to true as part of prev URL from the previous search call.
`parameters.query?`	`string`	The string used to filter the articles (required).
`parameters.start?`	`number`	(Deprecated) The starting index of the returned objects. Base index: 0.
`options?`	`RequestOptions`	-

Returns

knowledgebase.viewArticle

viewArticle: (parameters, options?) => Promise<string>;

Parameters

Parameter	Type
`parameters`	{ `pageId`: `number`; }
`parameters.pageId`	`number`
`options?`	`RequestOptions`

Returns

Promise<string>

organization

organization: object;

organization.addOrganization

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

Parameters

Parameter	Type	Description
`parameters`	{ `body`: { `organizationId`: `number`; `serviceDeskId?`: `string`; }; `serviceDeskId`: `string`; }	-
`parameters.body`	{ `organizationId`: `number`; `serviceDeskId?`: `string`; }	-
`parameters.body.organizationId?`	`number`	List of organizations, specified by 'ID' field values, to add to or remove from the service desk.
`parameters.body.serviceDeskId?`	`string`	Service desk Id for which, organization needs to be updated
`parameters.serviceDeskId?`	`string`	The ID of the service desk to which the organization will be added. This can alternatively be a project identifier.
`options?`	`RequestOptions`	-

Returns

Promise<void>

organization.addUsersToOrganization

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

Parameters

Parameter	Type	Description
`parameters`	{ `body`: { `accountIds?`: `string`[]; `organizationId?`: `number`; `usernames?`: `string`[]; }; `organizationId`: `number`; }	-
`parameters.body`	{ `accountIds?`: `string`[]; `organizationId?`: `number`; `usernames?`: `string`[]; }	-
`parameters.body.accountIds?`	`string`[]	List of customers, specific by account IDs, to add to or remove from the organization.
`parameters.body.organizationId?`	`number`	The organizationId in which users need to be added
`parameters.body.usernames?`	`string`[]	This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use `accountIds` instead.
`parameters.organizationId?`	`number`	The ID of the organization.
`options?`	`RequestOptions`	-

Returns

Promise<void>

organization.createOrganization

createOrganization: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  created?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  id?: string;
  name?: string;
  scimManaged?: boolean;
  uuid?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `name`: `string`; }	-
`parameters.name`	`string`	Name of the organization. Must contain 1-200 characters.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; created?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; id?: string; name?: string; scimManaged?: boolean; uuid?: string; }>

organization.deleteOrganization

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

Parameters

Parameter	Type	Description
`parameters`	{ `organizationId`: `number`; }	-
`parameters.organizationId`	`number`	The ID of the organization.
`options?`	`RequestOptions`	-

Returns

Promise<void>

organization.deleteProperty

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

Parameters

Parameter	Type	Description
`parameters`	{ `organizationId`: `string`; `propertyKey`: `string`; }	-
`parameters.organizationId`	`string`	The ID of the organization from which the property will be removed.
`parameters.propertyKey?`	`string`	The key of the property to remove.
`options?`	`RequestOptions`	-

Returns

Promise<void>

organization.getOrganization

getOrganization: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  created?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  id?: string;
  name?: string;
  scimManaged?: boolean;
  uuid?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `organizationId`: `number`; }	-
`parameters.organizationId`	`number`	The ID of the organization.
`options?`	`RequestOptions`	-

Returns

organization.getOrganizations

getOrganizations: (parameters?, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `accountId?`: `string`; `limit?`: `number`; `start?`: `number`; }	-
`parameters.accountId?`	`string`	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
`parameters.limit?`	`number`	The maximum number of organizations to return per page. Default: 50. See the Pagination section for more details.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
`options?`	`RequestOptions`	-

Returns

organization.getPropertiesKeys

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

Parameters

Parameter	Type	Description
`parameters`	{ `organizationId`: `string`; }	-
`parameters.organizationId`	`string`	The ID of the organization from which keys will be returned.
`options?`	`RequestOptions`	-

Returns

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

organization.getProperty

getProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `organizationId`: `string`; `propertyKey`: `string`; }	-
`parameters.organizationId`	`string`	The ID of the organization from which the property will be returned.
`parameters.propertyKey?`	`string`	The key of the property to return.
`options?`	`RequestOptions`	-

Returns

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

organization.getServiceDeskOrganizations

getServiceDeskOrganizations: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `accountId?`: `string`; `limit?`: `number`; `serviceDeskId`: `string`; `start?`: `number`; }	-
`parameters.accountId?`	`string`	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
`parameters.serviceDeskId?`	`string`	The ID of the service desk from which the organization list will be returned. This can alternatively be a project identifier.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
`options?`	`RequestOptions`	-

Returns

organization.getUsersInOrganization

getUsersInOrganization: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `limit?`: `number`; `organizationId`: `number`; `start?`: `number`; }	-
`parameters.limit?`	`number`	The maximum number of users to return per page. Default: 50. See the Pagination section for more details.
`parameters.organizationId?`	`number`	The ID of the organization.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
`options?`	`RequestOptions`	-

Returns

organization.removeOrganization

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

Parameters

Parameter	Type	Description
`parameters`	{ `body`: { `organizationId`: `number`; `serviceDeskId?`: `string`; }; `serviceDeskId`: `string`; }	-
`parameters.body`	{ `organizationId`: `number`; `serviceDeskId?`: `string`; }	-
`parameters.body.organizationId?`	`number`	List of organizations, specified by 'ID' field values, to add to or remove from the service desk.
`parameters.body.serviceDeskId?`	`string`	Service desk Id for which, organization needs to be updated
`parameters.serviceDeskId?`	`string`	The ID of the service desk from which the organization will be removed. This can alternatively be a project identifier.
`options?`	`RequestOptions`	-

Returns

Promise<void>

organization.removeUsersFromOrganization

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

Parameters

Parameter	Type	Description
`parameters`	{ `body`: { `accountIds?`: `string`[]; `organizationId?`: `number`; `usernames?`: `string`[]; }; `organizationId`: `number`; }	-
`parameters.body`	{ `accountIds?`: `string`[]; `organizationId?`: `number`; `usernames?`: `string`[]; }	-
`parameters.body.accountIds?`	`string`[]	List of customers, specific by account IDs, to add to or remove from the organization.
`parameters.body.organizationId?`	`number`	The organizationId in which users need to be added
`parameters.body.usernames?`	`string`[]	This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use `accountIds` instead.
`parameters.organizationId?`	`number`	The ID of the organization.
`options?`	`RequestOptions`	-

Returns

Promise<void>

organization.setProperty

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

Parameters

Parameter	Type	Description
`parameters`	{ `body`: `Record`<`string`, `any`>; `organizationId`: `string`; `propertyKey`: `string`; }	-
`parameters.body`	`Record`<`string`, `any`>	-
`parameters.organizationId?`	`string`	The ID of the organization on which the property will be set.
`parameters.propertyKey?`	`string`	The key of the organization's property. The maximum length of the key is 255 bytes.
`options?`	`RequestOptions`	-

Returns

Promise<void>

request

request: object;

request.addRequestParticipants

addRequestParticipants: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `accountIds?`: `string`[]; `issueIdOrKey`: `string`; `usernames?`: `string`[]; }	-
`parameters.accountIds?`	`string`[]	List of users, specified by account IDs, to add to or remove as participants in the request.
`parameters.issueIdOrKey?`	`string`	The ID or key of the customer request to have participants added.
`parameters.usernames?`	`string`[]	This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use `accountIds` instead.
`options?`	`RequestOptions`	-

Returns

request.answerApproval

answerApproval: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  approvers?: object[];
  canAnswerApproval?: boolean;
  completedDate?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  createdDate?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  finalDecision?: "pending" | string & object | "approved" | "declined";
  id?: string;
  name?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `approvalId`: `number`; `decision?`: `string` & `object` \| `"approve"` \| `"decline"`; `issueIdOrKey`: `string`; }	-
`parameters.approvalId`	`number`	The ID of the approval to be updated.
`parameters.decision?`	`string` & `object` \| `"approve"` \| `"decline"`	Response to the approval request.
`parameters.issueIdOrKey?`	`string`	The ID or key of the customer request to be updated.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; approvers?: object[]; canAnswerApproval?: boolean; completedDate?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; createdDate?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; finalDecision?: "pending" | string & object | "approved" | "declined"; id?: string; name?: string; }>

request.createCommentWithAttachment

createCommentWithAttachment: (parameters, options?) => Promise<{
[key: string]: unknown;
  attachments?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
  comment?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        self?: string;
     };
     attachments?: {
      [key: string]: unknown;
        _expands?: ...[];
        _links?: {
         [key: ...]: ...;
           base?: ...;
           context?: ...;
           next?: ...;
           prev?: ...;
           self?: ...;
        };
        isLastPage?: boolean;
        limit?: number;
        size?: number;
        start?: number;
        values?: ...[];
     };
     author?: {
      [key: string]: unknown;
        _links?: {
         [key: ...]: ...;
           avatarUrls?: ...;
           jiraRest?: ...;
           self?: ...;
        };
        accountId?: string;
        active?: boolean;
        displayName?: string;
        emailAddress?: string;
        key?: string;
        name?: string;
        timeZone?: string;
     };
     body?: string;
     created?: {
      [key: string]: unknown;
        epochMillis?: number;
        friendly?: string;
        iso8601?: string;
        jira?: string;
     };
     id?: string;
     public?: boolean;
     renderedBody?: {
      [key: string]: unknown;
        html?: string;
     };
  };
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `additionalComment?`: { `body?`: `string`; }; `issueIdOrKey`: `string`; `public?`: `boolean`; `temporaryAttachmentIds?`: `string`[]; }	-
`parameters.additionalComment?`	{ `body?`: `string`; }	-
`parameters.additionalComment.body?`	`string`	Content of the comment.
`parameters.issueIdOrKey?`	`string`	The ID or key of the customer request to which the attachment will be added.
`parameters.public?`	`boolean`	Controls whether the comment and its attachments are visible to customers
`parameters.temporaryAttachmentIds?`	`string`[]	List of IDs for the temporary attachments to be added to the customer request.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; attachments?: { [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; base?: string; context?: string; next?: string; prev?: string; self?: string; }; isLastPage?: boolean; limit?: number; size?: number; start?: number; values?: object[]; }; comment?: { [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; self?: string; }; attachments?: { [key: string]: unknown; _expands?: ...[]; _links?: { [key: ...]: ...; base?: ...; context?: ...; next?: ...; prev?: ...; self?: ...; }; isLastPage?: boolean; limit?: number; size?: number; start?: number; values?: ...[]; }; author?: { [key: string]: unknown; _links?: { [key: ...]: ...; avatarUrls?: ...; jiraRest?: ...; self?: ...; }; accountId?: string; active?: boolean; displayName?: string; emailAddress?: string; key?: string; name?: string; timeZone?: string; }; body?: string; created?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; id?: string; public?: boolean; renderedBody?: { [key: string]: unknown; html?: string; }; }; }>

request.createCustomerRequest

createCustomerRequest: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     agent?: string;
     jiraRest?: string;
     self?: string;
     web?: string;
  };
  actions?: {
   [key: string]: unknown;
     addAttachment?: {
      [key: string]: unknown;
        allowed?: boolean;
     };
     addComment?: {
      [key: string]: unknown;
        allowed?: boolean;
     };
     addParticipant?: {
      [key: string]: unknown;
        allowed?: boolean;
     };
     removeParticipant?: {
      [key: string]: unknown;
        allowed?: boolean;
     };
  };
  attachments?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
  comments?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
  createdDate?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  currentStatus?: {
   [key: string]: unknown;
     status?: string;
     statusCategory?: string & object | "NEW" | "DONE" | "UNDEFINED" | "INDETERMINATE";
     statusDate?: {
      [key: string]: unknown;
        epochMillis?: number;
        friendly?: string;
        iso8601?: string;
        jira?: string;
     };
  };
  issueId?: string;
  issueKey?: string;
  participants?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
  reporter?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        avatarUrls?: Record<..., ...>;
        jiraRest?: string;
        self?: string;
     };
     accountId?: string;
     active?: boolean;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     timeZone?: string;
  };
  requestFieldValues?: object[];
  requestType?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        self?: string;
     };
     canCreateRequest?: boolean;
     description?: string;
     fields?: {
      [key: string]: unknown;
        canAddRequestParticipants?: boolean;
        canRaiseOnBehalfOf?: boolean;
        requestTypeFields?: ...[];
     };
     groupIds?: string[];
     helpText?: string;
     icon?: {
      [key: string]: unknown;
        _links?: {
         [key: ...]: ...;
           iconUrls?: ...;
        };
        id?: string;
     };
     id?: string;
     issueTypeId?: string;
     name?: string;
     portalId?: string;
     practice?: string;
     restrictionStatus?: string & object | "OPEN" | "RESTRICTED";
     serviceDeskId?: string;
  };
  requestTypeId?: string;
  serviceDesk?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        self?: string;
     };
     id?: string;
     projectId?: string;
     projectKey?: string;
     projectName?: string;
     projectTypeKey?: string;
  };
  serviceDeskId?: string;
  sla?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
  status?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
  summary?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `channel?`: `string`; `form?`: { `answers?`: `Record`<`string`, { `adf?`: `unknown`; `choices?`: ...[]; `date?`: `string`; `files?`: ...[]; `text?`: `string`; `time?`: `string`; `users?`: ...[]; }>; }; `isAdfRequest?`: `boolean`; `raiseOnBehalfOf?`: `string`; `requestFieldValues?`: `Record`<`string`, `any`>; `requestParticipants?`: `string`[]; `requestTypeId?`: `string`; `serviceDeskId?`: `string`; }	-
`parameters.channel?`	`string`	(Experimental) Shows extra information for the request channel.
`parameters.form?`	{ `answers?`: `Record`<`string`, { `adf?`: `unknown`; `choices?`: ...[]; `date?`: `string`; `files?`: ...[]; `text?`: `string`; `time?`: `string`; `users?`: ...[]; }>; }	-
`parameters.form.answers?`	`Record`<`string`, { `adf?`: `unknown`; `choices?`: ...[]; `date?`: `string`; `files?`: ...[]; `text?`: `string`; `time?`: `string`; `users?`: ...[]; }>	JSON mapping of form field answers containing form field IDs and corresponding values.
`parameters.isAdfRequest?`	`boolean`	(Experimental) Whether to accept rich text fields in Atlassian Document Format (ADF).
`parameters.raiseOnBehalfOf?`	`string`	The `accountId` of the customer that the request is being raised on behalf of.
`parameters.requestFieldValues?`	`Record`<`string`, `any`>	JSON map of Jira field IDs and their values representing the content of the request.
`parameters.requestParticipants?`	`string`[]	List of customers to participate in the request, as a list of `accountId` values.
`parameters.requestTypeId?`	`string`	ID of the request type for the request.
`parameters.serviceDeskId?`	`string`	ID of the service desk in which to create the request.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; agent?: string; jiraRest?: string; self?: string; web?: string; }; actions?: { [key: string]: unknown; addAttachment?: { [key: string]: unknown; allowed?: boolean; }; addComment?: { [key: string]: unknown; allowed?: boolean; }; addParticipant?: { [key: string]: unknown; allowed?: boolean; }; removeParticipant?: { [key: string]: unknown; allowed?: boolean; }; }; attachments?: { [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; base?: string; context?: string; next?: string; prev?: string; self?: string; }; isLastPage?: boolean; limit?: number; size?: number; start?: number; values?: object[]; }; comments?: { [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; base?: string; context?: string; next?: string; prev?: string; self?: string; }; isLastPage?: boolean; limit?: number; size?: number; start?: number; values?: object[]; }; createdDate?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; currentStatus?: { [key: string]: unknown; status?: string; statusCategory?: string & object | "NEW" | "DONE" | "UNDEFINED" | "INDETERMINATE"; statusDate?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; }; issueId?: string; issueKey?: string; participants?: { [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; base?: string; context?: string; next?: string; prev?: string; self?: string; }; isLastPage?: boolean; limit?: number; size?: number; start?: number; values?: object[]; }; reporter?: { [key: string]: unknown; _links?: { [key: string]: unknown; avatarUrls?: Record<..., ...>; jiraRest?: string; self?: string; }; accountId?: string; active?: boolean; displayName?: string; emailAddress?: string; key?: string; name?: string; timeZone?: string; }; requestFieldValues?: object[]; requestType?: { [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; self?: string; }; canCreateRequest?: boolean; description?: string; fields?: { [key: string]: unknown; canAddRequestParticipants?: boolean; canRaiseOnBehalfOf?: boolean; requestTypeFields?: ...[]; }; groupIds?: string[]; helpText?: string; icon?: { [key: string]: unknown; _links?: { [key: ...]: ...; iconUrls?: ...; }; id?: string; }; id?: string; issueTypeId?: string; name?: string; portalId?: string; practice?: string; restrictionStatus?: string & object | "OPEN" | "RESTRICTED"; serviceDeskId?: string; }; requestTypeId?: string; serviceDesk?: { [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; id?: string; projectId?: string; projectKey?: string; projectName?: string; projectTypeKey?: string; }; serviceDeskId?: string; sla?: { [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; base?: string; context?: string; next?: string; prev?: string; self?: string; }; isLastPage?: boolean; limit?: number; size?: number; start?: number; values?: object[]; }; status?: { [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; base?: string; context?: string; next?: string; prev?: string; self?: string; }; isLastPage?: boolean; limit?: number; size?: number; start?: number; values?: object[]; }; summary?: string; }>

request.createRequestComment

createRequestComment: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  attachments?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
  author?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        avatarUrls?: Record<..., ...>;
        jiraRest?: string;
        self?: string;
     };
     accountId?: string;
     active?: boolean;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     timeZone?: string;
  };
  body?: string;
  created?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  id?: string;
  public?: boolean;
  renderedBody?: {
   [key: string]: unknown;
     html?: string;
  };
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `body?`: `string`; `issueIdOrKey`: `string`; `public?`: `boolean`; }	-
`parameters.body?`	`string`	Content of the comment.
`parameters.issueIdOrKey?`	`string`	The ID or key of the customer request to which the comment will be added.
`parameters.public?`	`boolean`	Indicates whether the comment is public (true) or private/internal (false).
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; self?: string; }; attachments?: { [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; base?: string; context?: string; next?: string; prev?: string; self?: string; }; isLastPage?: boolean; limit?: number; size?: number; start?: number; values?: object[]; }; author?: { [key: string]: unknown; _links?: { [key: string]: unknown; avatarUrls?: Record<..., ...>; jiraRest?: string; self?: string; }; accountId?: string; active?: boolean; displayName?: string; emailAddress?: string; key?: string; name?: string; timeZone?: string; }; body?: string; created?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; id?: string; public?: boolean; renderedBody?: { [key: string]: unknown; html?: string; }; }>

request.getApprovalById

getApprovalById: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  approvers?: object[];
  canAnswerApproval?: boolean;
  completedDate?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  createdDate?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  finalDecision?: "pending" | string & object | "approved" | "declined";
  id?: string;
  name?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `approvalId`: `number`; `issueIdOrKey`: `string`; }	-
`parameters.approvalId`	`number`	The ID of the approval to be returned.
`parameters.issueIdOrKey?`	`string`	The ID or key of the customer request the approval is on.
`options?`	`RequestOptions`	-

Returns

request.getApprovals

getApprovals: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `limit?`: `number`; `start?`: `number`; }	-
`parameters.issueIdOrKey`	`string`	The ID or key of the customer request to be queried for its approvals.
`parameters.limit?`	`number`	The maximum number of approvals to return per page. Default: 50. See the Pagination section for more details.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
`options?`	`RequestOptions`	-

Returns

request.getAttachmentContent

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

Parameters

Parameter	Type	Description
`parameters`	{ `attachmentId`: `number`; `issueIdOrKey`: `string`; }	-
`parameters.attachmentId`	`number`	The ID for the attachment
`parameters.issueIdOrKey?`	`string`	The ID or key for the customer request the attachment is associated with
`options?`	`RequestOptions`	-

Returns

Promise<ArrayBuffer | ArrayBufferView<ArrayBufferLike>>

request.getAttachmentsForRequest

getAttachmentsForRequest: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `limit`: `number`; `start`: `number`; }	-
`parameters.issueIdOrKey`	`string`	The ID or key of the customer request from which the attachments will be listed.
`parameters.limit?`	`number`	The maximum number of comments to return per page. Default: 50. See the Pagination section for more details.
`parameters.start?`	`number`	The starting index of the returned attachment. Base index: 0. See the Pagination section for more details.
`options?`	`RequestOptions`	-

Returns

request.getAttachmentThumbnail

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

Parameters

Parameter	Type	Description
`parameters`	{ `attachmentId`: `number`; `issueIdOrKey`: `string`; }	-
`parameters.attachmentId`	`number`	The ID of the attachment.
`parameters.issueIdOrKey?`	`string`	The ID or key for the customer request the attachment is associated with
`options?`	`RequestOptions`	-

Returns

Promise<ArrayBuffer | ArrayBufferView<ArrayBufferLike>>

request.getCustomerRequestByIdOrKey

getCustomerRequestByIdOrKey: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     agent?: string;
     jiraRest?: string;
     self?: string;
     web?: string;
  };
  actions?: {
   [key: string]: unknown;
     addAttachment?: {
      [key: string]: unknown;
        allowed?: boolean;
     };
     addComment?: {
      [key: string]: unknown;
        allowed?: boolean;
     };
     addParticipant?: {
      [key: string]: unknown;
        allowed?: boolean;
     };
     removeParticipant?: {
      [key: string]: unknown;
        allowed?: boolean;
     };
  };
  attachments?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
  comments?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
  createdDate?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  currentStatus?: {
   [key: string]: unknown;
     status?: string;
     statusCategory?: string & object | "NEW" | "DONE" | "UNDEFINED" | "INDETERMINATE";
     statusDate?: {
      [key: string]: unknown;
        epochMillis?: number;
        friendly?: string;
        iso8601?: string;
        jira?: string;
     };
  };
  issueId?: string;
  issueKey?: string;
  participants?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
  reporter?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        avatarUrls?: Record<..., ...>;
        jiraRest?: string;
        self?: string;
     };
     accountId?: string;
     active?: boolean;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     timeZone?: string;
  };
  requestFieldValues?: object[];
  requestType?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        self?: string;
     };
     canCreateRequest?: boolean;
     description?: string;
     fields?: {
      [key: string]: unknown;
        canAddRequestParticipants?: boolean;
        canRaiseOnBehalfOf?: boolean;
        requestTypeFields?: ...[];
     };
     groupIds?: string[];
     helpText?: string;
     icon?: {
      [key: string]: unknown;
        _links?: {
         [key: ...]: ...;
           iconUrls?: ...;
        };
        id?: string;
     };
     id?: string;
     issueTypeId?: string;
     name?: string;
     portalId?: string;
     practice?: string;
     restrictionStatus?: string & object | "OPEN" | "RESTRICTED";
     serviceDeskId?: string;
  };
  requestTypeId?: string;
  serviceDesk?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        self?: string;
     };
     id?: string;
     projectId?: string;
     projectKey?: string;
     projectName?: string;
     projectTypeKey?: string;
  };
  serviceDeskId?: string;
  sla?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
  status?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
  summary?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string`[]; `issueIdOrKey`: `string`; }	-
`parameters.expand?`	`string`[]	A multi-value parameter indicating which properties of the customer request to expand, where: - `serviceDesk` returns additional service desk details. - `requestType` returns additional customer request type details. - `participant` returns the participant details. - `sla` returns the SLA information. - `status` returns the status transitions, in chronological order. - `attachment` returns the attachments. - `action` returns the actions that the user can or cannot perform. - `comment` returns the comments. - `comment.attachment` returns the attachment details for each comment. - `comment.renderedBody` (Experimental) return the rendered body in HTML format (in addition to the raw body) for each comment.
`parameters.issueIdOrKey?`	`string`	The ID or Key of the customer request to be returned
`options?`	`RequestOptions`	-

Returns

request.getCustomerRequests

getCustomerRequests: (parameters?, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `approvalStatus?`: `string`; `expand?`: `string`[]; `limit?`: `number`; `organizationId?`: `number`; `requestOwnership?`: `string`[]; `requestStatus?`: `string`; `requestTypeId?`: `number`; `searchTerm?`: `string`; `serviceDeskId?`: `number`; `start?`: `number`; }	-
`parameters.approvalStatus?`	`string`	Filters results to customer requests based on their approval status: - `MY_PENDING_APPROVAL` returns customer requests pending the user's approval. - `MY_HISTORY_APPROVAL` returns customer requests where the user was an approver. Note: Valid only when used with requestOwnership=APPROVER.
`parameters.expand?`	`string`[]	A multi-value parameter indicating which properties of the customer request to expand, where: - `serviceDesk` returns additional details for each service desk. - `requestType` returns additional details for each request type. - `participant` returns the participant details, if any, for each customer request. - `sla` returns the SLA information on each customer request. - `status` returns the status transitions, in chronological order, for each customer request. - `attachment` returns the attachments for the customer request. - `action` returns the actions that the user can or cannot perform on this customer request. - `comment` returns the comments, if any, for each customer request. - `comment.attachment` returns the attachment details, if any, for each comment. - `comment.renderedBody` (Experimental) returns the rendered body in HTML format (in addition to the raw body) for each comment.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
`parameters.organizationId?`	`number`	Filters customer requests that belong to a specific organization (note that the user must be a member of that organization). Note: Valid only when used with requestOwnership=ORGANIZATION.
`parameters.requestOwnership?`	`string`[]	Filters customer requests using the following values: - `OWNED_REQUESTS` returns customer requests where the user is the creator. - `PARTICIPATED_REQUESTS` returns customer requests where the user is a participant. - `ORGANIZATION` returns customer requests for an organization of which the user is a member when used in conjunction with `organizationId`. - `ALL_ORGANIZATIONS` returns customer requests that belong to all organizations of which the user is a member. - `APPROVER` returns customer requests where the user is an approver. Can be used in conjunction with `approvalStatus` to filter pending or complete approvals. - `ALL_REQUESTS` returns all customer requests. Deprecated and will be removed, as the returned requests may change if more values are added in the future. Instead, explicitly list the desired filtering strategies. Multiple values of the query parameter are supported. For example, `requestOwnership=OWNED_REQUESTS&requestOwnership=PARTICIPATED_REQUESTS` will only return customer requests where the user is the creator or a participant. If not specified, filtering defaults to `OWNED_REQUESTS`, `PARTICIPATED_REQUESTS`, and `ALL_ORGANIZATIONS`.
`parameters.requestStatus?`	`string`	Filters customer requests where the request is closed, open, or either of the two where: - `CLOSED_REQUESTS` returns customer requests that are closed. - `OPEN_REQUESTS` returns customer requests that are open. - `ALL_REQUESTS` returns all customer requests.
`parameters.requestTypeId?`	`number`	Filters customer requests by request type. Note that the `serviceDeskId` must be specified for the service desk in which the request type belongs.
`parameters.searchTerm?`	`string`	Filters customer requests where the request summary matches the `searchTerm`. Wildcards can be used in the `searchTerm` parameter.
`parameters.serviceDeskId?`	`number`	Filters customer requests by service desk.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
`options?`	`RequestOptions`	-

Returns

request.getCustomerRequestStatus

getCustomerRequestStatus: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `limit?`: `number`; `start?`: `number`; }	-
`parameters.issueIdOrKey`	`string`	The ID or key of the customer request to be retrieved.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
`options?`	`RequestOptions`	-

Returns

request.getCustomerTransitions

getCustomerTransitions: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `limit?`: `number`; `start?`: `number`; }	-
`parameters.issueIdOrKey`	`string`	The ID or key of the customer request whose transitions will be retrieved.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
`options?`	`RequestOptions`	-

Returns

request.getRequestCommentById

getRequestCommentById: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  attachments?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
  author?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        avatarUrls?: Record<..., ...>;
        jiraRest?: string;
        self?: string;
     };
     accountId?: string;
     active?: boolean;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     timeZone?: string;
  };
  body?: string;
  created?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  id?: string;
  public?: boolean;
  renderedBody?: {
   [key: string]: unknown;
     html?: string;
  };
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `commentId`: `number`; `expand?`: `string`[]; `issueIdOrKey`: `string`; }	-
`parameters.commentId`	`number`	The ID of the comment to retrieve.
`parameters.expand?`	`string`[]	A multi-value parameter indicating which properties of the comment to expand: - `attachment` returns the attachment details, if any, for the comment. (If you want to get all attachments for a request, use servicedeskapi/request/{issueIdOrKey}/attachment.) - `renderedBody` (Experimental) returns the rendered body in HTML format (in addition to the raw body) of the comment.
`parameters.issueIdOrKey?`	`string`	The ID or key of the customer request that contains the comment.
`options?`	`RequestOptions`	-

Returns

request.getRequestComments

getRequestComments: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string`[]; `internal?`: `boolean`; `issueIdOrKey`: `string`; `limit?`: `number`; `public?`: `boolean`; `start?`: `number`; }	-
`parameters.expand?`	`string`[]	A multi-value parameter indicating which properties of the comment to expand: - `attachment` returns the attachment details, if any, for each comment. (If you want to get all attachments for a request, use servicedeskapi/request/{issueIdOrKey}/attachment.) - `renderedBody` (Experimental) returns the rendered body in HTML format (in addition to the raw body) for each comment.
`parameters.internal?`	`boolean`	Specifies whether to return internal comments or not. Default: true.
`parameters.issueIdOrKey?`	`string`	The ID or key of the customer request whose comments will be retrieved.
`parameters.limit?`	`number`	The maximum number of comments to return per page. Default: 50. See the Pagination section for more details.
`parameters.public?`	`boolean`	Specifies whether to return public comments or not. Default: true.
`parameters.start?`	`number`	The starting index of the returned comments. Base index: 0. See the Pagination section for more details.
`options?`	`RequestOptions`	-

Returns

request.getRequestParticipants

getRequestParticipants: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `limit?`: `number`; `start?`: `number`; }	-
`parameters.issueIdOrKey`	`string`	The ID or key of the customer request to be queried for its participants.
`parameters.limit?`	`number`	The maximum number of request types to return per page. Default: 50. See the Pagination section for more details.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
`options?`	`RequestOptions`	-

Returns

request.getSlaInformation

getSlaInformation: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `limit?`: `number`; `start?`: `number`; }	-
`parameters.issueIdOrKey`	`string`	The ID or key of the customer request whose SLAs will be retrieved.
`parameters.limit?`	`number`	The maximum number of request types to return per page. Default: 50. See the Pagination section for more details.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
`options?`	`RequestOptions`	-

Returns

request.getSlaInformationById

getSlaInformationById: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  completedCycles?: object[];
  id?: string;
  name?: string;
  ongoingCycle?: {
   [key: string]: unknown;
     breached?: boolean;
     breachTime?: {
      [key: string]: unknown;
        epochMillis?: number;
        friendly?: string;
        iso8601?: string;
        jira?: string;
     };
     elapsedTime?: {
      [key: string]: unknown;
        friendly?: string;
        millis?: number;
     };
     goalDuration?: {
      [key: string]: unknown;
        friendly?: string;
        millis?: number;
     };
     paused?: boolean;
     remainingTime?: {
      [key: string]: unknown;
        friendly?: string;
        millis?: number;
     };
     startTime?: {
      [key: string]: unknown;
        epochMillis?: number;
        friendly?: string;
        iso8601?: string;
        jira?: string;
     };
     withinCalendarHours?: boolean;
  };
  slaDisplayFormat?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `slaMetricId`: `number`; }	-
`parameters.issueIdOrKey`	`string`	The ID or key of the customer request whose SLAs will be retrieved.
`parameters.slaMetricId?`	`number`	The ID or key of the SLAs metric to be retrieved.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; completedCycles?: object[]; id?: string; name?: string; ongoingCycle?: { [key: string]: unknown; breached?: boolean; breachTime?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; elapsedTime?: { [key: string]: unknown; friendly?: string; millis?: number; }; goalDuration?: { [key: string]: unknown; friendly?: string; millis?: number; }; paused?: boolean; remainingTime?: { [key: string]: unknown; friendly?: string; millis?: number; }; startTime?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; withinCalendarHours?: boolean; }; slaDisplayFormat?: string; }>

request.getSubscriptionStatus

getSubscriptionStatus: (parameters, options?) => Promise<{
[key: string]: unknown;
  subscribed?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; }	-
`parameters.issueIdOrKey`	`string`	The ID or key of the customer request to be queried for subscription status.
`options?`	`RequestOptions`	-

Returns

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

request.performCustomerTransition

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

Parameters

Parameter	Type	Description
`parameters`	{ `additionalComment?`: { `body?`: `string`; }; `id?`: `string`; `issueIdOrKey`: `string`; }	-
`parameters.additionalComment?`	{ `body?`: `string`; }	-
`parameters.additionalComment.body?`	`string`	Content of the comment.
`parameters.id?`	`string`	ID of the transition to be performed.
`parameters.issueIdOrKey?`	`string`	ID or key of the issue to transition
`options?`	`RequestOptions`	-

Returns

Promise<void>

request.removeRequestParticipants

removeRequestParticipants: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `accountIds?`: `string`[]; `issueIdOrKey`: `string`; `usernames?`: `string`[]; }	-
`parameters.accountIds?`	`string`[]	List of users, specified by account IDs, to add to or remove as participants in the request.
`parameters.issueIdOrKey?`	`string`	The ID or key of the customer request to have participants removed.
`parameters.usernames?`	`string`[]	This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use `accountIds` instead.
`options?`	`RequestOptions`	-

Returns

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

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; }	-
`parameters.issueIdOrKey`	`string`	The ID or key of the customer request to be subscribed to.
`options?`	`RequestOptions`	-

Returns

Promise<void>

request.unsubscribe

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

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; }	-
`parameters.issueIdOrKey`	`string`	The ID or key of the customer request to be unsubscribed from.
`options?`	`RequestOptions`	-

Returns

Promise<void>

request.validateCustomerRequest

validateCustomerRequest: (parameters, options?) => Promise<{
[key: string]: unknown;
  errorMessage?: string;
  errorMessages?: string[];
  fieldErrors?: object[];
  formErrors?: object[];
  reasonKey?: string;
  valid?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `channel?`: `string`; `form?`: { `answers?`: `Record`<`string`, { `adf?`: `unknown`; `choices?`: ...[]; `date?`: `string`; `files?`: ...[]; `text?`: `string`; `time?`: `string`; `users?`: ...[]; }>; }; `isAdfRequest?`: `boolean`; `raiseOnBehalfOf?`: `string`; `requestFieldValues?`: `Record`<`string`, `any`>; `requestParticipants?`: `string`[]; `requestTypeId?`: `string`; `serviceDeskId?`: `string`; }	-
`parameters.channel?`	`string`	(Experimental) Shows extra information for the request channel.
`parameters.form?`	{ `answers?`: `Record`<`string`, { `adf?`: `unknown`; `choices?`: ...[]; `date?`: `string`; `files?`: ...[]; `text?`: `string`; `time?`: `string`; `users?`: ...[]; }>; }	-
`parameters.form.answers?`	`Record`<`string`, { `adf?`: `unknown`; `choices?`: ...[]; `date?`: `string`; `files?`: ...[]; `text?`: `string`; `time?`: `string`; `users?`: ...[]; }>	JSON mapping of form field answers containing form field IDs and corresponding values.
`parameters.isAdfRequest?`	`boolean`	(Experimental) Whether to accept rich text fields in Atlassian Document Format (ADF).
`parameters.raiseOnBehalfOf?`	`string`	The `accountId` of the customer that the request is being raised on behalf of.
`parameters.requestFieldValues?`	`Record`<`string`, `any`>	JSON map of Jira field IDs and their values representing the content of the request.
`parameters.requestParticipants?`	`string`[]	List of customers to participate in the request, as a list of `accountId` values.
`parameters.requestTypeId?`	`string`	ID of the request type for the request.
`parameters.serviceDeskId?`	`string`	ID of the service desk in which to create the request.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; errorMessage?: string; errorMessages?: string[]; fieldErrors?: object[]; formErrors?: object[]; reasonKey?: string; valid?: boolean; }>

servicedesk

servicedesk: object;

servicedesk.addCustomers

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

Parameters

Parameter	Type	Description
`parameters`	{ `accountIds?`: `string`[]; `serviceDeskId`: `string`; `usernames?`: `string`[]; }	-
`parameters.accountIds?`	`string`[]	List of users, specified by account IDs, to add to or remove from a service desk.
`parameters.serviceDeskId?`	`string`	The ID of the service desk the customer list should be returned from. This can alternatively be a project identifier.
`parameters.usernames?`	`string`[]	This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use `accountIds` instead.
`options?`	`RequestOptions`	-

Returns

Promise<void>

servicedesk.addCustomersSkippingPermissionCheck

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

Parameters

Parameter	Type	Description
`parameters`	{ `accountIds?`: `string`[]; `serviceDeskId`: `string`; `usernames?`: `string`[]; }	-
`parameters.accountIds?`	`string`[]	List of users, specified by account IDs, to add to or remove from a service desk.
`parameters.serviceDeskId?`	`string`	The ID of the service desk to add customers to. This can alternatively be a project identifier.
`parameters.usernames?`	`string`[]	This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use `accountIds` instead.
`options?`	`RequestOptions`	-

Returns

Promise<void>

servicedesk.attachTemporaryFile

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

Parameters

Parameter	Type	Description
`parameters`	{ `body`: `object`[]; `serviceDeskId`: `string`; }	-
`parameters.body`	`object`[]	-
`parameters.serviceDeskId?`	`string`	The ID of the Service Desk to which the file will be attached. This can alternatively be a project identifier.
`options?`	`RequestOptions`	-

Returns

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

servicedesk.getIssuesInQueue

getIssuesInQueue: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `limit?`: `number`; `queueId`: `number`; `serviceDeskId`: `string`; `start?`: `number`; }	-
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
`parameters.queueId?`	`number`	The ID of the queue whose customer requests will be returned.
`parameters.serviceDeskId?`	`string`	The ID of the service desk containing the queue to be queried. This can alternatively be a project identifier.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
`options?`	`RequestOptions`	-

Returns

servicedesk.getQueue

getQueue: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  fields?: string[];
  id?: string;
  issueCount?: number;
  jql?: string;
  name?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `includeCount?`: `boolean`; `queueId`: `number`; `serviceDeskId`: `string`; }	-
`parameters.includeCount?`	`boolean`	Specifies whether to include each queue's customer request (issue) count in the response.
`parameters.queueId?`	`number`	ID of the required queue.
`parameters.serviceDeskId?`	`string`	ID of the service desk whose queues will be returned. This can alternatively be a project identifier.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; fields?: string[]; id?: string; issueCount?: number; jql?: string; name?: string; }>

servicedesk.getQueues

getQueues: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `includeCount?`: `boolean`; `limit?`: `number`; `serviceDeskId`: `string`; `start?`: `number`; }	-
`parameters.includeCount?`	`boolean`	Specifies whether to include each queue's customer request (issue) count in the response.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
`parameters.serviceDeskId?`	`string`	ID of the service desk whose queues will be returned. This can alternatively be a project identifier.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
`options?`	`RequestOptions`	-

Returns

servicedesk.getRequestTypeById

getRequestTypeById: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  canCreateRequest?: boolean;
  description?: string;
  fields?: {
   [key: string]: unknown;
     canAddRequestParticipants?: boolean;
     canRaiseOnBehalfOf?: boolean;
     requestTypeFields?: object[];
  };
  groupIds?: string[];
  helpText?: string;
  icon?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        iconUrls?: Record<..., ...>;
     };
     id?: string;
  };
  id?: string;
  issueTypeId?: string;
  name?: string;
  portalId?: string;
  practice?: string;
  restrictionStatus?: string & object | "OPEN" | "RESTRICTED";
  serviceDeskId?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string`[]; `requestTypeId`: `string`; `serviceDeskId`: `string`; }	-
`parameters.expand?`	`string`[]	-
`parameters.requestTypeId?`	`string`	The ID of the customer request type to be returned.
`parameters.serviceDeskId?`	`string`	The ID of the service desk whose customer request type is to be returned. This can alternatively be a project identifier.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; self?: string; }; canCreateRequest?: boolean; description?: string; fields?: { [key: string]: unknown; canAddRequestParticipants?: boolean; canRaiseOnBehalfOf?: boolean; requestTypeFields?: object[]; }; groupIds?: string[]; helpText?: string; icon?: { [key: string]: unknown; _links?: { [key: string]: unknown; iconUrls?: Record<..., ...>; }; id?: string; }; id?: string; issueTypeId?: string; name?: string; portalId?: string; practice?: string; restrictionStatus?: string & object | "OPEN" | "RESTRICTED"; serviceDeskId?: string; }>

servicedesk.getRequestTypeFields

getRequestTypeFields: (parameters, options?) => Promise<{
[key: string]: unknown;
  canAddRequestParticipants?: boolean;
  canRaiseOnBehalfOf?: boolean;
  requestTypeFields?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string`[]; `requestTypeId`: `number`; `serviceDeskId`: `string`; }	-
`parameters.expand?`	`string`[]	Use expand to include additional information in the response. This parameter accepts `hiddenFields` that returns hidden fields associated with the request type.
`parameters.requestTypeId?`	`number`	The ID of the request types whose fields are to be returned.
`parameters.serviceDeskId?`	`string`	The ID of the service desk containing the request types whose fields are to be returned. This can alternatively be a project identifier.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; canAddRequestParticipants?: boolean; canRaiseOnBehalfOf?: boolean; requestTypeFields?: object[]; }>

servicedesk.getRequestTypeGroups

getRequestTypeGroups: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `limit?`: `number`; `serviceDeskId`: `string`; `start?`: `number`; }	-
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
`parameters.serviceDeskId?`	`string`	The ID of the service desk whose customer request type groups are to be returned. This can alternatively be a project identifier.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
`options?`	`RequestOptions`	-

Returns

servicedesk.getRequestTypes

getRequestTypes: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string`[]; `groupId?`: `number`; `includeHiddenRequestTypesInSearch?`: `boolean`; `limit?`: `number`; `restrictionStatus?`: `string`; `searchQuery?`: `string`; `serviceDeskId`: `string`; `start?`: `number`; }	-
`parameters.expand?`	`string`[]	-
`parameters.groupId?`	`number`	Filters results to those in a customer request type group.
`parameters.includeHiddenRequestTypesInSearch?`	`boolean`	Whether to include hidden request types when searching with `searchQuery`.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
`parameters.restrictionStatus?`	`string`	Request type restriction status (`open` or `restricted`) used to filter the results.
`parameters.searchQuery?`	`string`	The string to be used to filter the results.
`parameters.serviceDeskId?`	`string`	The ID of the service desk whose customer request types are to be returned. This can alternatively be a project identifier.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
`options?`	`RequestOptions`	-

Returns

servicedesk.getServiceDeskArticles

getServiceDeskArticles: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `cursor?`: `string`; `highlight?`: `boolean`; `limit?`: `number`; `prev?`: `boolean`; `query`: `string`; `serviceDeskId`: `string`; `start?`: `number`; }	-
`parameters.cursor?`	`string`	Pointer to a set of search results, returned as part of the next or prev URL from the previous search call.
`parameters.highlight?`	`boolean`	If set to true matching query term in the title and excerpt will be highlighted using the `@@@hl@@@term@@@endhl@@@` syntax. Default: false.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50. See the section for more details.
`parameters.prev?`	`boolean`	Should navigate to the previous page. Defaulted to false. Set to true as part of prev URL from the previous search call.
`parameters.query?`	`string`	The string used to filter the articles (required).
`parameters.serviceDeskId?`	`string`	-
`parameters.start?`	`number`	(Deprecated) The starting index of the returned objects. Base index: 0.
`options?`	`RequestOptions`	-

Returns

servicedesk.getServiceDeskById

getServiceDeskById: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  id?: string;
  projectId?: string;
  projectKey?: string;
  projectName?: string;
  projectTypeKey?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `serviceDeskId`: `string`; }	-
`parameters.serviceDeskId`	`string`	The ID of the service desk to return. This can alternatively be a project identifier.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; id?: string; projectId?: string; projectKey?: string; projectName?: string; projectTypeKey?: string; }>

servicedesk.getServiceDesks

getServiceDesks: (parameters?, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `limit?`: `number`; `start?`: `number`; }	-
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
`options?`	`RequestOptions`	-

Function: createServiceDeskClient() ​

Parameters ​

Returns ​

assets ​

assets.getAssetsWorkspaces ​

Parameters ​

Returns ​

assets.getInsightWorkspaces ​

Parameters ​

Returns ​

Deprecated ​

customer ​

customer.createCustomer ​

Parameters ​

Returns ​

customer.createCustomerSkippingPermissionCheck ​

Parameters ​

Returns ​

customer.revokePortalOnlyAccessForUser ​

Parameters ​

Returns ​

info ​

info.getInfo ​

Parameters ​

Returns ​

knowledgebase ​

knowledgebase.getArticles ​

Parameters ​

Returns ​

knowledgebase.viewArticle ​

Parameters ​

Returns ​

organization ​

organization.addOrganization ​

Parameters ​

Returns ​

organization.addUsersToOrganization ​

Parameters ​

Returns ​

organization.createOrganization ​

Parameters ​

Returns ​

organization.deleteOrganization ​

Parameters ​

Returns ​

organization.deleteProperty ​

Parameters ​

Returns ​

organization.getOrganization ​

Parameters ​

Returns ​

organization.getOrganizations ​

Parameters ​

Returns ​

organization.getPropertiesKeys ​

Parameters ​

Returns ​

organization.getProperty ​

Parameters ​

Returns ​

organization.getServiceDeskOrganizations ​

Parameters ​

Returns ​

organization.getUsersInOrganization ​

Parameters ​

Returns ​

organization.removeOrganization ​

Parameters ​

Returns ​

organization.removeUsersFromOrganization ​

Parameters ​

Returns ​

organization.setProperty ​

Parameters ​

Returns ​

request ​

request.addRequestParticipants ​

Parameters ​

Returns ​

request.answerApproval ​

Function: createServiceDeskClient()

Parameters

Returns

assets

assets.getAssetsWorkspaces

Parameters

Returns

assets.getInsightWorkspaces

Parameters

Returns

Deprecated

customer

customer.createCustomer

Parameters

Returns

customer.createCustomerSkippingPermissionCheck

Parameters

Returns

customer.revokePortalOnlyAccessForUser

Parameters

Returns

info

info.getInfo

Parameters

Returns

knowledgebase

knowledgebase.getArticles

Parameters

Returns

knowledgebase.viewArticle

Parameters

Returns

organization

organization.addOrganization

Parameters

Returns

organization.addUsersToOrganization

Parameters

Returns

organization.createOrganization

Parameters

Returns

organization.deleteOrganization

Parameters

Returns

organization.deleteProperty

Parameters

Returns

organization.getOrganization

Parameters

Returns

organization.getOrganizations

Parameters

Returns

organization.getPropertiesKeys

Parameters

Returns

organization.getProperty

Parameters

Returns

organization.getServiceDeskOrganizations

Parameters

Returns

organization.getUsersInOrganization

Parameters

Returns

organization.removeOrganization

Parameters

Returns

organization.removeUsersFromOrganization

Parameters

Returns

organization.setProperty

Parameters

Returns

request

request.addRequestParticipants

Parameters

Returns

request.answerApproval