Retrieve the current state of configurable settings for the projects Queue.
string
RequiredReturns the requested state of settings.
any
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/servicedeskapi/admin/queues/{projectKey}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Allows to set whether service project queues should include the issue count on the Queues page. This is a global setting that if disabled will override any project level settings. The default value is always true. The intention of this method is that if you are experiencing performance issues with queue rendering on agent pages, then this setting might be of use to try toggling the queue count on/off. The queue count executes a JQL query that may take time on instances with many projects/issues.
boolean
Returns a boolean of the updated state.
any
1
2
3
4
5
6
curl --request PUT \
--url 'http://{baseurl}/rest/servicedeskapi/admin/queues/include-count' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data 'true'Allows to set whether service project queues should include the issue count on the Queues page for specified project. This is a project level setting, and it's enabled state can be overrided by the global setting. To enable queue count this and the global setting must be true. The default value is always true. The intention of this method is that if you are experiencing performance issues with queue rendering on agent pages, then this setting might be of use to try toggling the queue count on/off. The queue count executes a JQL query that may take time on instances with many projects/issues.
string
Requiredboolean
Returns a boolean of the updated state.
any
1
2
3
4
5
6
curl --request PUT \
--url 'http://{baseurl}/rest/servicedeskapi/admin/queues/{projectKey}/include-count' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data 'true'Allows to set whether service project queues should always return as soon as possible, and schedule the queue count to happen off-thread. This is a global setting that if disabled will override any project level settings. The default value is always false. The intention of this method is that if you are experiencing performance issues with queue rendering on agent pages, then this setting might be of use to try toggling the queue count on/off. With this enabled, any project that also enables this setting, will return the latest cached value (up to a expiry time limit) and schedule a new count to occur in a new thread. That new thread will update the cache value when done, and subsequent update of the queue view, through polling or refresh, will take that as the latest cache value. When no cache value, or it has expired, the queue count will be blank. The queue count will still be specific to the agent viewing the queue, so any view restrictions will remain. This setting is an option to try if would are having some performance issues, but do not want to turn queue count off completely, and are happy with an approximate value.
boolean
Returns a boolean of the updated state.
any
1
2
3
4
5
6
curl --request PUT \
--url 'http://{baseurl}/rest/servicedeskapi/admin/queues/cache-count' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data 'true'Allows to set whether service project queues should include the issue count on the Queues page for specified project. This is a project level setting, and it's enabled state can be overrided by the global setting. To enable queue count this and the global setting must be true. The default value is always true. The intention of this method is that if you are experiencing performance issues with queue rendering on agent pages, then this setting might be of use to try toggling the queue count on/off. With this enabled, if the global setting is also enabled, queues for project will return the latest cached value (up to a expiry time limit) and schedule a new count to occur in a new thread. That new thread will update the cache value when done, and subsequent update of the queue view, through polling or refresh, will take that as the latest cache value. When no cache value, or it has expired, the queue count will be blank. The queue count will still be specific to the agent viewing the queue, so any view restrictions will remain. This setting is an option to try if would are having some performance issues, but do not want to turn queue count off completely, and are happy with an approximate value.
string
Requiredboolean
Returns a boolean of the updated state.
any
1
2
3
4
5
6
curl --request PUT \
--url 'http://{baseurl}/rest/servicedeskapi/admin/queues/{projectKey}/cache-count' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data 'true'Rate this page: