Function getSlaById

getSlaById<ThrowOnError extends boolean = true>(
    options: Options<GetSlaByIdData, ThrowOnError>,
): RequestResult<
    {
        data: {
            attributes: { createdAt: string; currentVersion: number };
            id: string;
            relationships: {
                createdBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
                versions: { data: { id: string; type: string }[] };
            };
            type: string;
        };
        included: {
            attributes: {
                createdAt: string;
                criteria: {
                    and: { conversation_channel: { operator: string; value: string } }[];
                };
                description: string;
                hours: string;
                metrics: {
                    firstResponse: {
                        enabled: boolean;
                        times: {
                            "1": number;
                            "2": number;
                            "3": number;
                            "4": number;
                            "5": number;
                        };
                    };
                    longestUnrespondedMessage: {
                        enabled: boolean;
                        times: {
                            "1": number;
                            "2": number;
                            "3": number;
                            "4": number;
                            "5": number;
                        };
                    };
                    totalConversationOpenTime: {
                        enabled: boolean;
                        times: { [key: string]: unknown };
                    };
                    totalCustomerWaitTime: {
                        enabled: boolean;
                        times: { [key: string]: unknown };
                    };
                };
                name: string;
                version: number;
            };
            id: string;
            relationships: {
                createdBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
                sla: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
Get SLA by ID Retrieves an SLA based on the unique SLA ID.

Use the optional versions query param to retrieve information about SLA versions.

Any one of the following roles is required for this endpoint:

Legacy Role Equivalent Permission Set Role

org.user.sla.read org.permission.sla.read
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetSlaByIdData, ThrowOnError>
Returns RequestResult<
    {
        data: {
            attributes: { createdAt: string; currentVersion: number };
            id: string;
            relationships: {
                createdBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
                versions: { data: { id: string; type: string }[] };
            };
            type: string;
        };
        included: {
            attributes: {
                createdAt: string;
                criteria: {
                    and: { conversation_channel: { operator: string; value: string } }[];
                };
                description: string;
                hours: string;
                metrics: {
                    firstResponse: {
                        enabled: boolean;
                        times: {
                            "1": number;
                            "2": number;
                            "3": number;
                            "4": number;
                            "5": number;
                        };
                    };
                    longestUnrespondedMessage: {
                        enabled: boolean;
                        times: {
                            "1": number;
                            "2": number;
                            "3": number;
                            "4": number;
                            "5": number;
                        };
                    };
                    totalConversationOpenTime: {
                        enabled: boolean;
                        times: { [key: string]: unknown };
                    };
                    totalCustomerWaitTime: {
                        enabled: boolean;
                        times: { [key: string]: unknown };
                    };
                };
                name: string;
                version: number;
            };
            id: string;
            relationships: {
                createdBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
                sla: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
- Defined in src/api/sdk.gen.ts:5012

Function getSlaById

Type Parameters

Parameters

Settings