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;
};
slaDisplayFormat?: string;
}>;Defined in: src/serviceDesk/api/request.ts:656
This method returns the details for an SLA on a customer request.
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
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
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; }>