Skip to content

Function: getSlaInformation() ​

ts
function getSlaInformation(
   client, 
   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;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Defined in: src/serviceDeskServer/api/customerRequests.ts:293

Returns the SLA information for a customer request for a given request Id/key.A request can have zero or more SLA values. Each SLA value can have zero or more "completed cycles" and zero or 1 "ongoing cycles".Each cycle has information on when it started and stopped, and whether it breached the SLA goal.

Permissions:

The calling user must be an agent.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ issueIdOrKey: string; limit?: number; start?: number; }-
parameters.issueIdOrKeystringThe id or key of the customer request.
parameters.limit?numberThe maximum number of items to return per page. Default: 50.
parameters.start?numberThe starting index of the returned objects. Base index: 0.
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; maxResultWindow?: number; size?: number; start?: number; values?: object[]; }>