Skip to content

Function: getServiceDeskById() ​

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

Defined in: src/serviceDesk/api/servicedesk.ts:69

This method returns a service desk. Use this method to get service desk details whenever your application component is passed a service desk ID but needs to display other service desk details.

Permissions required: Permission to access the Service Desk. For example, being the Service Desk's Administrator or one of its Agents or Users.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ serviceDeskId: string; }-
parameters.serviceDeskIdstringThe 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; }>