Skip to main content
GET
/
history
/
process-definition
/
cleanable-process-instance-report
Get Cleanable Process Instance Report
curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/process-definition/cleanable-process-instance-report \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "processDefinitionId": "invoice:1:7bf79f13-ef95-11e6-b6e6-34f39ab71d4e",
    "processDefinitionKey": "invoice",
    "processDefinitionName": "Invoice Receipt",
    "processDefinitionVersion": 1,
    "historyTimeToLive": 5,
    "finishedProcessInstanceCount": 100,
    "cleanableProcessInstanceCount": 53,
    "tenantId": "aTenantId"
  },
  {
    "processDefinitionId": "invoice:2:7bf79f13-ef95-11e6-b6e6-34f39ab71d4e",
    "processDefinitionKey": "invoice",
    "processDefinitionName": "Invoice Receipt v2.0",
    "processDefinitionVersion": 2,
    "historyTimeToLive": 5,
    "finishedProcessInstanceCount": 1000,
    "cleanableProcessInstanceCount": 13,
    "tenantId": "aTenantId"
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
processDefinitionIdIn
string

Filter by process definition ids. Must be a comma-separated list of process definition ids.

​
processDefinitionKeyIn
string

Filter by process definition keys. Must be a comma-separated list of process definition keys.

​
tenantIdIn
string

Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids.

​
withoutTenantId
boolean

Only include process definitions which belong to no tenant. Value may only be true, as false is the default behavior.

​
compact
boolean

Only include process instances which have more than zero finished instances. Value may only be true, as false is the default behavior.

​
sortBy
enum<string>

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

Available options:
finished
​
sortOrder
enum<string>

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Available options:
asc,
desc
​
firstResult
integer

Pagination of results. Specifies the index of the first result to return.

​
maxResults
integer

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Response

Request successful.

​
processDefinitionId
string | null

The id of the process definition.

​
processDefinitionKey
string | null

The key of the process definition.

​
processDefinitionName
string | null

The name of the process definition.

​
processDefinitionVersion
integer | null

The version of the process definition.

​
historyTimeToLive
integer | null

The history time to live of the process definition.

​
finishedProcessInstanceCount
integer | null

The count of the finished historic process instances.

​
cleanableProcessInstanceCount
integer | null

The count of the cleanable historic process instances, referring to history time to live.

​
tenantId
string | null

The tenant id of the process definition.