Function: getSlaInformationById()

function getSlaInformationById(
   client, 
   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;
  };
}>;

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

Returns the SLA information for a customer request for a given request Id/key and SLA metric Id.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

Parameter	Type	Description
client	Client	-
parameters	{ issueIdOrKey: string; slaMetricId: string; }	-
parameters.issueIdOrKey	string	The id or key of the customer request.
parameters.slaMetricId?	string	The id of the SLA metric.
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; }; }>