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.
string
Requiredstring
number
number
Returns the queues belonging to the provided service project, at the specified page of the results.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
"_expands": [
"<string>"
],
"size": 1,
"start": 0,
"limit": 50,
"isLastPage": true,
"_links": {
"base": "<string>",
"context": "<string>",
"next": "<string>",
"prev": "<string>",
"self": "<string>"
},
"values": [
{
"id": "<string>",
"name": "<string>",
"jql": "<string>",
"fields": [
"<string>"
],
"issueCount": 2154,
"_links": {
"self": "<string>"
}
}
]
}Creates a queue with the given properties.
Permissions:
The calling user must have permission to create a queue, i.e. they must be an admin of the service project that the queue belongs to.
string
RequiredThe queue to create.
string
string
array<string>
Returns the created queue.
1
2
3
4
5
6
7
8
9
10
11
curl --request POST \
--url 'http://{baseurl}/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"jql": "<string>",
"fields": [
"<string>"
]
}'1
2
3
4
5
6
7
8
9
10
11
12
{
"id": "<string>",
"name": "<string>",
"jql": "<string>",
"fields": [
"<string>"
],
"issueCount": 2154,
"_links": {
"self": "<string>"
}
}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.
string
Requiredstring
Requiredstring
Returns the queue with the given queue id belonging to the provided service project.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
{
"id": "<string>",
"name": "<string>",
"jql": "<string>",
"fields": [
"<string>"
],
"issueCount": 2154,
"_links": {
"self": "<string>"
}
}Updates the queue properties with the new properties. If a property is not passed it will not be updated.
Permissions:
The calling user must have permission to update a queue, i.e. they must be an admin of the service project that the queue belongs to.
string
Requiredstring
RequiredThe new properties of the queue.
string
string
array<string>
Returns the updated queue
1
2
3
4
5
6
7
8
9
10
11
curl --request POST \
--url 'http://{baseurl}/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"jql": "<string>",
"fields": [
"<string>"
]
}'1
2
3
4
5
6
7
8
9
10
11
12
{
"id": "<string>",
"name": "<string>",
"jql": "<string>",
"fields": [
"<string>"
],
"issueCount": 2154,
"_links": {
"self": "<string>"
}
}Deletes the queue for the given queue id.
Permissions:
The calling user must have permission to delete the queue, i.e. they must be an admin of the service project that the queue belongs to.
string
Requiredstring
RequiredDelete queue was successful.
any
1
2
3
curl --request DELETE \
--url 'http://{baseurl}/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}' \
--header 'Accept: application/json'Returns a page of issues inside a queue for a given queue ID. Only fields that the queue is configured to show are returned. For example, if a queue is configured to show only Description and Due Date, then only those two fields are returned for each issue in the queue.
Permissions:
The calling user must have permission to view the requested queue, i.e. they must be an agent of the service project that the queue belongs to.
string
Requiredstring
Requirednumber
number
Returns the issues belonging to the provided queue, at the specified page of the results.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}/issue' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"_expands": [
"<string>"
],
"size": 1,
"start": 0,
"limit": 50,
"isLastPage": true,
"_links": {
"base": "<string>",
"context": "<string>",
"next": "<string>",
"prev": "<string>",
"self": "<string>"
},
"values": [
null
]
}Reorder queues for the users. This is the order in which the queues will appear in agent view. The API requires all queue ids to be passed in the new order.
Permissions:
The calling user must have permission to reorder the queue, i.e. they must be an admin of the service project that the queue belongs to.
string
RequiredThe new order of the queues.
string
Returns the queues list in the new order
1
2
3
4
5
curl --request POST \
--url 'http://{baseurl}/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/reorder' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '"<string>"'1
2
3
4
5
6
7
8
9
10
11
12
{
"id": "<string>",
"name": "<string>",
"jql": "<string>",
"fields": [
"<string>"
],
"issueCount": 2154,
"_links": {
"self": "<string>"
}
}Rate this page: