The REST API provides the following methods for retrieving message counts for the Error and Hold Queues:

GET /api/errorqueue/count

URI

GET /api/errorqueue/count

Description

Retrieves the number of messages on the error queue. Limits the count to only errors produced in lockers for which the user has the 'Search Error and Hold Queues' access right.

Request Header

Accept: text/plain, text/html

Request Body

Empty.

Response Status 200 OK - operation successful.

Response Body

The number of messages on the error queue.

Access Rights

'View Error Queue count REST API'.
'Search Error and Hold Queues'.

GET /api/holdqueue/count

URI

GET /api/holdqueue/count

Description

Retrieves the number of messages on the hold queue. Limits the count to only errors produced in lockers for which the user has the 'Search Error and Hold Queues' access right.

Request Header

Accept: text/plain, text/html

Request Body

Empty.

Response Status 200 OK - operation successful.

Response Body

The number of messages on the hold queue.

Access Rights

'View Hold Queue count REST API'.
'Search Error and Hold Queues'.