Function: getCustomerRequestByIdOrKey()

function getCustomerRequestByIdOrKey(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     agent?: string;
     jiraRest?: string;
     self?: string;
     web?: string;
  };
  actions?: {
   [key: string]: unknown;
     addAttachment?: {
      [key: string]: unknown;
        allowed?: boolean;
     };
     addComment?: {
      [key: string]: unknown;
        allowed?: boolean;
     };
     addParticipant?: {
      [key: string]: unknown;
        allowed?: boolean;
     };
     removeParticipant?: {
      [key: string]: unknown;
        allowed?: boolean;
     };
  };
  attachments?: {
   [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[];
  };
  comments?: {
   [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[];
  };
  createdDate?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  currentStatus?: {
   [key: string]: unknown;
     status?: string;
     statusCategory?: string & object | "NEW" | "DONE" | "UNDEFINED" | "INDETERMINATE";
     statusDate?: {
      [key: string]: unknown;
        epochMillis?: number;
        friendly?: string;
        iso8601?: string;
        jira?: string;
     };
  };
  issueId?: string;
  issueKey?: string;
  participants?: {
   [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[];
  };
  reporter?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        avatarUrls?: Record<string, string>;
        jiraRest?: string;
        self?: string;
     };
     accountId?: string;
     active?: boolean;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     timeZone?: string;
  };
  requestFieldValues?: object[];
  requestType?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        self?: string;
     };
     canCreateRequest?: boolean;
     description?: string;
     fields?: {
      [key: string]: unknown;
        canAddRequestParticipants?: boolean;
        canRaiseOnBehalfOf?: boolean;
        requestTypeFields?: object[];
     };
     groupIds?: string[];
     helpText?: string;
     icon?: {
      [key: string]: unknown;
        _links?: {
         [key: string]: unknown;
           iconUrls?: Record<string, string>;
        };
        id?: string;
     };
     id?: string;
     issueTypeId?: string;
     name?: string;
     portalId?: string;
     practice?: string;
     restrictionStatus?: string & object | "OPEN" | "RESTRICTED";
     serviceDeskId?: string;
  };
  requestTypeId?: string;
  serviceDesk?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        self?: string;
     };
     id?: string;
     projectId?: string;
     projectKey?: string;
     projectName?: string;
     projectTypeKey?: string;
  };
  serviceDeskId?: string;
  sla?: {
   [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[];
  };
  status?: {
   [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[];
  };
  summary?: string;
}>;

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

This method returns a customer request.

Permissions required: Permission to access the specified service desk.

Response limitations: For customers, only a request they created, was created on their behalf, or they are participating in will be returned.

Note: requestFieldValues does not include hidden fields. To get a list of request type fields that includes hidden fields, see /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ expand?: string[]; issueIdOrKey: string; }	-
parameters.expand?	string[]	A multi-value parameter indicating which properties of the customer request to expand, where: - serviceDesk returns additional service desk details. - requestType returns additional customer request type details. - participant returns the participant details. - sla returns the SLA information. - status returns the status transitions, in chronological order. - attachment returns the attachments. - action returns the actions that the user can or cannot perform. - comment returns the comments. - comment.attachment returns the attachment details for each comment. - comment.renderedBody (Experimental) return the rendered body in HTML format (in addition to the raw body) for each comment.
parameters.issueIdOrKey?	string	The ID or Key of the customer request to be returned
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; agent?: string; jiraRest?: string; self?: string; web?: string; }; actions?: { [key: string]: unknown; addAttachment?: { [key: string]: unknown; allowed?: boolean; }; addComment?: { [key: string]: unknown; allowed?: boolean; }; addParticipant?: { [key: string]: unknown; allowed?: boolean; }; removeParticipant?: { [key: string]: unknown; allowed?: boolean; }; }; attachments?: { [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[]; }; comments?: { [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[]; }; createdDate?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; currentStatus?: { [key: string]: unknown; status?: string; statusCategory?: string & object | "NEW" | "DONE" | "UNDEFINED" | "INDETERMINATE"; statusDate?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; }; issueId?: string; issueKey?: string; participants?: { [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[]; }; reporter?: { [key: string]: unknown; _links?: { [key: string]: unknown; avatarUrls?: Record<string, string>; jiraRest?: string; self?: string; }; accountId?: string; active?: boolean; displayName?: string; emailAddress?: string; key?: string; name?: string; timeZone?: string; }; requestFieldValues?: object[]; requestType?: { [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; self?: string; }; canCreateRequest?: boolean; description?: string; fields?: { [key: string]: unknown; canAddRequestParticipants?: boolean; canRaiseOnBehalfOf?: boolean; requestTypeFields?: object[]; }; groupIds?: string[]; helpText?: string; icon?: { [key: string]: unknown; _links?: { [key: string]: unknown; iconUrls?: Record<string, string>; }; id?: string; }; id?: string; issueTypeId?: string; name?: string; portalId?: string; practice?: string; restrictionStatus?: string & object | "OPEN" | "RESTRICTED"; serviceDeskId?: string; }; requestTypeId?: string; serviceDesk?: { [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; id?: string; projectId?: string; projectKey?: string; projectName?: string; projectTypeKey?: string; }; serviceDeskId?: string; sla?: { [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[]; }; status?: { [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[]; }; summary?: string; }>