Skip to content

Function: getAttachmentsForRequest() ​

ts
function getAttachmentsForRequest(
   client, 
   parameters, 
   options?
): Promise<{
[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[];
}>;

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

This method returns all the attachments for a customer requests.

Permissions required: Permission to view the customer request.

Response limitations: Customers will only get a list of public attachments.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ issueIdOrKey: string; limit: number; start: number; }-
parameters.issueIdOrKeystringThe ID or key of the customer request from which the attachments will be listed.
parameters.limit?numberThe maximum number of comments to return per page. Default: 50. See the Pagination section for more details.
parameters.start?numberThe starting index of the returned attachment. Base index: 0. See the Pagination section for more details.
options?RequestOptions-

Returns ​

Promise<{ [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[]; }>