Function: getQueue()

function getQueue(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  fields?: string[];
  id?: string;
  issueCount?: number;
  jql?: string;
  name?: string;
}>;

Defined in: src/serviceDeskServer/api/queues.ts:73

Returns the queue for a given service project id and queue id. The returned queue will include an issue count for 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; queueId: string; serviceDeskId: string; }	-
parameters.includeCount?	string	Specifies whether to include the issue count of queue in the response. Valid values: true/false. Default: false.
parameters.queueId?	string	The id of the queue.
parameters.serviceDeskId?	string	The ID of the service project.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; fields?: string[]; id?: string; issueCount?: number; jql?: string; name?: string; }>