/
[GET] /queues

[GET] /queues

/api/bpm/queues

Description

An endpoint for retrieving information about the elements which are currently in the worker queue. The query parameter locked must be set to true, if false the endpoint returns null.

Required Systemrole

R_WFADM_START (ID = 20)

Request
Method

GET

Request Optional Query Parameter

  • locked(boolean): If the parameter is true, then all elements which are currently in the worker queue are returned. Default:false.

Response
Format

JSON

Minimum Version

1.2.0

Request
Example

/api/bpm/queues?locked=true

/api/bpm/queues?locked=false

Result
Example when locked=true

{ "objects": [ { "id": "43A890DAB9604F8B80F1AE1B0817FB7A", "processName": "lockedProcesses 32", "taskName": "Route", "state": "started", "targetState": "startEventExecuted", "locked": true, "lockTime": "2025-10-13T16:14:57+02:00", "creationTime": "2025-10-13T16:14:56+02:00", "server": "WF-System3" }, { "id": "8064B1076E6D49E48CCECC9E41CDE3A7", "processName": "lockedProcesses 33", "taskName": "StartActivity", "state": "initialized", "targetState": "started", "locked": true, "lockTime": "2025-10-13T16:14:57+02:00", "creationTime": "2025-10-13T16:14:57+02:00", "server": "WF-System3" } ], "numItems": 2, "hasMoreItems": false, "totalNumItems": 2 }

Result
Example when locked=false

Not implemented yet!