Get Cleanable Decision Instance Report

Retrieves a report about a decision definition and finished decision instances relevant to history cleanup (see History cleanup), so that you can tune the history time to live. These reports include the count of the finished historic decision instances, cleanable decision instances and basic decision definition data - id, key, name and version. The size of the result set can be retrieved by using the Get Cleanable Decision Instance Report Count method.

Method

GET /history/decision-definition/cleanable-decision-instance-report

Parameters

Query Parameters

Name Description
decisionDefinitionIdIn Filter by decision definition ids. Must be a comma-separated list of decision definition ids.
decisionDefinitionKeyIn Filter by decision definition keys. Must be a comma-separated list of decision definition keys.
firstResult Pagination of results. Specifies the index of the first result to return.
maxResults Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Result

A JSON array containing finished decision instance information relevant to history cleanup. Each report result has the following properties:

Name Value Description
decisionDefinitionId String The id of the decision definition.
decisionDefinitionKey String The key of the decision definition.
decisionDefinitionName String The name of the decision definition.
decisionDefinitionName String The name of the decision definition.
decisionDefinitionVersion Number The version of the decision definition.
historyTimeToLive Number The history time to live of the decision definition.
finishedDecisionInstanceCount Number The count of the finished historic decision instances.
cleanableDecisionInstanceCount Number The count of the cleanable historic decision instances, referring to history time to live.

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/decision-definition/cleanable-decision-instance-report

Response

[
  {
    "decisionDefinitionId":"invoice:1:7bf79f13-ef95-11e6-b6e6-34f39ab71d4e",
    "decisionDefinitionKey":"invoice",
    "decisionDefinitionName":"Invoice Receipt",
    "decisionDefinitionVersion":1,
    "historyTimeToLive":5,
    "finishedDecisionInstanceCount":100
    "cleanableDecisionInstanceCount":53
  },
  {
    "decisionDefinitionId":"invoice:2:7bf79f13-ef95-11e6-b6e6-34f39ab71d4e",
    "decisionDefinitionKey":"invoice",
    "decisionDefinitionName":"Invoice Receipt v2.0",
    "decisionDefinitionVersion":2,
    "historyTimeToLive":5,
    "finishedDecisionInstanceCount":1000
    "cleanableDecisionInstanceCount":13
  }

]

On this Page: