Function: getQueues()

function getQueues(
   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:25

Returns a page of queues defined inside a service project, for a given service project ID. The returned queues will include an issue count for each queue (represented in issueCount field) if the query param includeCount is set to true (defaults to false).

Permissions:

The calling user must be an agent of the given service project.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ includeCount?: string; limit?: number; serviceDeskId: string; start?: number; }	-
parameters.includeCount?	string	Specifies whether to include the issue count of each queue in the response. Valid values: true/false. Default: false.
parameters.limit?	number	The maximum number of items to return per page. Default: 50.
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[]; }>