Get Historic Case Activity Statistics

Retrieves historic statistics of a given case definition grouped by activities. These statistics include the number of active, available, completed, disabled, enabled and completed case activity instances.

Note: This only includes historic data.

Method

GET /history/case-definition/{id}/statistics

Parameters

Path Parameters

Name Description
id The id of the case definition.

Result

A JSON array containing statistics results per activity. Each object has the following properties:

Name Value Description
id String The id of the activity the results are aggregated for.
active Number The total number of all active instances of the activity.
available Number The total number of all available instances of the activity.
completed Number The total number of all completed instances of the activity.
disabled Number The total number of all disabled instances of the activity.
enabled Number The total number of all enabled instances of the activity.
terminated Number The total number of all terminated instances of the activity.

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/case-definition/aCaseDefinitionId/statistics

Response

[
  {
    "id": "anActivity",
    "active": 123,
    "available": 0,
    "completed": 50,
    "disabled": 0,
    "enabled": 0,
    "terminated": 60
  },
  {
    "id":"anotherActivity",
    "active": 11,
    "available": 60,
    "completed": 5,
    "disabled": 0,
    "enabled": 55,
    "terminated": 5
  }
]

On this Page: