Description | An endpoint for retrieving the total number of processes for a given process definition id, grouped by their states. |
|---|
Required Systemrole | R_WFADM_START (ID = 20) |
|---|
Request
Method | GET |
|---|
Request Mandatory Query Parameters | |
|---|
Request Optional Query Parameter | organizationId(String): The id of the organization where the forwarded process definition is located. If not provided, the currently active organization is used. isCompleted(boolean): The parameter specifies whether to return active processes (false), historical processes (true). Default: false.
|
|---|
Response
Format | JSON |
|---|
Minimum Version | 1.4.0 |
|---|
Request
Example | /api/bpm/processes/count?processDefinitionId=EDAFE928C2C8404E9D14CAD234674737
/api/bpm/processes/count?processDefinitionId=016049CB84CD4304B3EC834A5EDD167A&isCompleted=true
|
|---|
Result
Example when isCompleted=false | {
"suspended": 1,
"running": 4
} |
|---|
Result
Example when isCompleted=true | {
"cancelled": 1,
"finished": 2
} |
|---|
Response codes | |
|---|