Get Queue by external ID

Overview

Use this API to retrieve the details of a single queue based on external ID.

Permissions

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'.
SecurityoAuthUser or oAuthClient
Request
path Parameters
id
required
string

External ID

Examples:
Ext208920010
query Parameters
$attribute
string

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

Available values: all, description, created, bookmarks, channels, 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
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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal server error

get/queue/ext-id/{id}
Request samples
Response samples
application/json
    

  • Retrieving the summary attributes of a queue. Note that since only summary attributes are requested, externalId is not included in the response.
    • 

  • /core/workassignmentmgr/v3/queue/ext-id/ext120236
    • 



{
  • "queue": [
    ]
}