Get Cleanable Process Instance Report Count
Queries for the number of report results about a process definition and finished process instances relevant to history cleanup (see History cleanup). Takes the same parameters as the Get Cleanable Process Instance Report method.
Method
GET /history/process-definition/cleanable-process-instance-report/count
Parameters
Query Parameters
| Name | Description |
|---|---|
| processDefinitionIdIn | Filter by process definition ids. Must be a comma-separated list of process definition ids. |
| processDefinitionKeyIn | Filter by process definition keys. Must be a comma-separated list of process definition keys. |
| tenantIdIn | Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids. |
| withoutTenantId | Only include process definitions which belong to no tenant. Value may only be true, as false is the default behavior. |
| compact | Only include process instances which have more than zero finished instances. Value may only be true, as false is the default behavior. |
Result
A JSON array containing finished process instance information relevant to history cleanup. Each report result has the following properties:
| Name | Value | Description |
|---|---|---|
| count | Number | The number of report results. |
Response Codes
| Code | Media type | Description |
|---|---|---|
| 200 | application/json | Request successful. |
| 500 | application/json | See the Introduction for the error response format. |
Examples
Request
GET /history/process-definition/cleanable-process-instance-report/count
Response
{
"count": 1
}