Get Queues by IDs

Overview

Use this API to retrieve one or more queues identified by IDs. To provide multiple IDs, a comma separated string must be used in request URI. A maximum of 75 IDs is allowed per request. Neither pagination nor range query parameters are supported by this API.

Permissions

Actor Permission
User All of the following are required:
  • If logged in user is a department user:
    • User must have 'View' permission on the queues provided in the request.
  • If the logged in user is a global user, one of the below is required:
    • User must have 'Administer' permission on the department of provided queues.
    • User must have one of following privileges: 'View partition resources', 'Manage partition resources'.
Client Application No additional permission required.
SecurityoAuthUser or oAuthClient
Request
path Parameters
ids
required
string <= 20000 characters

Pass one id or comma sperated list of id(s).

Examples:
Providing single ID.
1001
Providing multiple IDs.
1001,1002
query Parameters
$attribute
string

Server can be prompted to return additional attributes of resource representation using $attribute common query parameter.

Actor Available values
User / Client Application
  • If single queue ID provided: all, description, created, createdBy, bookmarks, channels, externalId, custom.<name>
  • If multiple queue IDs provided: all, description, created, createdBy, externalId, custom.<name>
Examples:
$attribute=
Attributes 'created' and 'description' are returned in server response.
$attribute=created,description
All the attributes are returned in server response.
$attribute=all
$sort
string

Objects returned in server response are sorted based on the attribute supplied under $sort.

Enum: "id" "name"
$order
string

Common query parameter $order.

Enum: "asc" "desc"
header Parameters
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Responses
200

OK

  • The request was successfully executed.
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal server error

get/queues/{ids}
Request samples
Response samples
application/json
    

  • Retrieving the summary attributes of a single queue.
    • 

  • /core/workassignmentmgr/v3/queue/1001
    • 



{
  • "queue": [
    ]
}