Skip to content

Function: getSlaInformation()

ts
function getSlaInformation(client, parameters): 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[];
}>;

Defined in: src/serviceDesk/api/request.ts:517

This method returns all the SLA records on a customer request. A customer request can have zero or more SLAs. Each SLA can have recordings for zero or more "completed cycles" and zero or 1 "ongoing cycle". Each cycle includes information on when it started and stopped, and whether it breached the SLA goal.

Permissions required:

  • Agent for the Service Desk containing the queried customer request, AND
  • Browse Projects permission on the project containing the customer request, including any restrictions imposed by issue security schemes or custom permission schemes on the specific issue.

Parameters

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

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[]; }>