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/serviceDesk/api/servicedesk.ts:236

This method returns a specific queues in a service desk. To include a customer request count for the queue (in the issueCount field) in the response, set the query parameter includeCount to true (its default is false).

Permissions required: service desk's Agent.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ includeCount?: boolean; queueId: number; serviceDeskId: string; }	-
parameters.includeCount?	boolean	Specifies whether to include each queue's customer request (issue) count in the response.
parameters.queueId?	number	ID of the required queue.
parameters.serviceDeskId?	string	ID of the service desk whose queues will be returned. This can alternatively be a project identifier.
options?	RequestOptions	-

Returns

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