Function getApprovalById

getApprovalById(
    client: Client,
    parameters: { approvalId: number; issueIdOrKey: string },
    options?: RequestOptions,
): Promise<
    {
        _links?: { self?: string; [key: string]: unknown };
        approvers?: {
            approver?: {
                _links?: {
                    avatarUrls?: Record<(...), (...)>;
                    jiraRest?: string;
                    self?: string;
                    [key: string]: unknown;
                };
                accountId?: string;
                active?: boolean;
                displayName?: string;
                emailAddress?: string;
                key?: string;
                name?: string;
                timeZone?: string;
                [key: string]: unknown;
            };
            approverDecision?: "pending"
            | string & {}
            | "approved"
            | "declined";
            [key: string]: unknown;
        }[];
        canAnswerApproval?: boolean;
        completedDate?: {
            epochMillis?: number;
            friendly?: string;
            iso8601?: string;
            jira?: string;
            [key: string]: unknown;
        };
        createdDate?: {
            epochMillis?: number;
            friendly?: string;
            iso8601?: string;
            jira?: string;
            [key: string]: unknown;
        };
        finalDecision?: "pending"
        | string & {}
        | "approved"
        | "declined";
        id?: string;
        name?: string;
        [key: string]: unknown;
    },
>
This method returns an approval. Use this method to determine the status of an approval and the list of approvers.

Permissions required: Permission to view the customer request.
Parameters
- client: Client
- parameters: { approvalId: number; issueIdOrKey: string }
  - approvalId: number
    
    The ID of the approval to be returned.
  - issueIdOrKey: string
    
    The ID or key of the customer request the approval is on.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        _links?: { self?: string; [key: string]: unknown };
        approvers?: {
            approver?: {
                _links?: {
                    avatarUrls?: Record<(...), (...)>;
                    jiraRest?: string;
                    self?: string;
                    [key: string]: unknown;
                };
                accountId?: string;
                active?: boolean;
                displayName?: string;
                emailAddress?: string;
                key?: string;
                name?: string;
                timeZone?: string;
                [key: string]: unknown;
            };
            approverDecision?: "pending"
            | string & {}
            | "approved"
            | "declined";
            [key: string]: unknown;
        }[];
        canAnswerApproval?: boolean;
        completedDate?: {
            epochMillis?: number;
            friendly?: string;
            iso8601?: string;
            jira?: string;
            [key: string]: unknown;
        };
        createdDate?: {
            epochMillis?: number;
            friendly?: string;
            iso8601?: string;
            jira?: string;
            [key: string]: unknown;
        };
        finalDecision?: "pending"
        | string & {}
        | "approved"
        | "declined";
        id?: string;
        name?: string;
        [key: string]: unknown;
    },
>
- Defined in src/serviceDesk/api/request.ts:238

Function getApprovalById

Parameters

approvalId: number

issueIdOrKey: string

Settings