Skip to main content
GET
/
history
/
decision-definition
/
cleanable-decision-instance-report
Get Cleanable Decision Instance Report
curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/decision-definition/cleanable-decision-instance-report \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "decisionDefinitionId": "invoice:1:7bf79f13-ef95-11e6-b6e6-34f39ab71d4e",
    "decisionDefinitionKey": "invoice",
    "decisionDefinitionName": "Invoice Receipt",
    "decisionDefinitionVersion": 1,
    "historyTimeToLive": 5,
    "finishedDecisionInstanceCount": 100,
    "cleanableDecisionInstanceCount": 53,
    "tenantId": "aTenantId"
  },
  {
    "decisionDefinitionId": "invoice:2:7bf79f13-ef95-11e6-b6e6-34f39ab71d4e",
    "decisionDefinitionKey": "invoice",
    "decisionDefinitionName": "Invoice Receipt v2.0",
    "decisionDefinitionVersion": 2,
    "historyTimeToLive": 5,
    "finishedDecisionInstanceCount": 1000,
    "cleanableDecisionInstanceCount": 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

​
decisionDefinitionIdIn
string

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

​
decisionDefinitionKeyIn
string

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

​
tenantIdIn
string

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

​
withoutTenantId
boolean

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

​
compact
boolean

Only include decision 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.

​
decisionDefinitionId
string | null

The id of the decision definition.

​
decisionDefinitionKey
string | null

The key of the decision definition.

​
decisionDefinitionName
string | null

The name of the decision definition.

​
decisionDefinitionVersion
integer<int32> | null

The version of the decision definition.

​
historyTimeToLive
integer<int32> | null

The history time to live of the decision definition.

​
finishedDecisionInstanceCount
integer<int64> | null

The count of the finished historic decision instances.

​
cleanableDecisionInstanceCount
integer<int64> | null

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

​
tenantId
string | null

The tenant id of the decision definition.