Function: getRequestComments()

function getRequestComments(
   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;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Defined in: src/serviceDeskServer/api/customerRequests.ts:33

Returns all comments on a customer request, for a given request Id/key.

Permissions:

Only comments that the calling user can see are returned.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ internal?: string; issueIdOrKey: string; limit?: number; public?: string; start?: number; }	-
parameters.internal?	string	Specifies whether to return internal comments or not. Default: true.
parameters.issueIdOrKey?	string	The id or key of the customer request.
parameters.limit?	number	The maximum number of items to return per page. Default: 50.
parameters.public?	string	Specifies whether to return public comments or not. Default: true.
parameters.start?	number	The starting index of the returned objects. Base index: 0.
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; maxResultWindow?: number; size?: number; start?: number; values?: object[]; }>