Get Finished Case Instance Report

Retrieves a report about a case definition and finished case instances relevant to history cleanup (see History cleanup), so that you can tune the history time to live. These reports include a count of the finished historic case instances, cleanable case instances and basic case definition data - id, key, name and version.

Method

GET /history/case-definition/finished-case-instance-report

Result

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

Name Value Description
caseDefinitionId String The id of the case definition.
caseDefinitionKey String The key of the case definition.
caseDefinitionName String The name of the case definition.
caseDefinitionName String The name of the case definition.
caseDefinitionVersion Number The version of the case definition.
historyTimeToLive Number The history time to live of the case definition.
finishedCaseInstanceCount Number The count of the finished historic case instances.
cleanableCaseInstanceCount Number The count of the cleanable historic case instances, referring to history time to live.

Response Codes

Code Media type Description
200 application/json Request successful.
403 application/json If the authenticated user is unauthorized to see the requested information.

Examples

Request

GET /history/case-definition/finished-case-instance-report

Response

[
  {
    "caseDefinitionId":"invoice:1:7bf79f13-ef95-11e6-b6e6-34f39ab71d4e",
    "caseDefinitionKey":"invoice",
    "caseDefinitionName":"Invoice Receipt",
    "caseDefinitionVersion":1,
    "historyTimeToLive":"5",
    "finishedCaseInstanceCount":100
    "cleanableCaseInstanceCount":53
  },
  {
    "caseDefinitionId":"invoice:2:7bf79f13-ef95-11e6-b6e6-34f39ab71d4e",
    "caseDefinitionKey":"invoice",
    "caseDefinitionName":"Invoice Receipt v2.0",
    "caseDefinitionVersion":2,
    "historyTimeToLive":"5",
    "finishedCaseInstanceCount":1000
    "cleanableCaseInstanceCount":13
  }

]

On this Page: