Function: getIssuesInQueue()

function getIssuesInQueue(
   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/queues.ts:138

Returns a page of issues inside a queue for a given queue ID. Only fields that the queue is configured to show are returned. For example, if a queue is configured to show only Description and Due Date, then only those two fields are returned for each issue in the queue. Permissions: The calling user must have permission to view the requested queue, i.e. they must be an agent of the service project that the queue belongs to. Note: The total number of issues across all pages that can be returned using paginated search is limited to the maxResultWindow, which is defined by the underlying search engine. The current value is returned in the maxResultWindow property of the response. If not set, it means there is no limit.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ limit?: number; queueId: string; serviceDeskId: string; start?: number; }	-
parameters.limit?	number	The maximum number of items to return per page. Default: 50.
parameters.queueId?	string	The id of the queue.
parameters.serviceDeskId?	string	The ID of the service project.
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[]; }>