Sign in
Historic Process Definition

Get Historic Activity Statistics

Retrieves historic statistics of a given process definition, grouped by activities. These statistics include the number of running activity instances and, optionally, the number of canceled activity instances, finished activity instances and activity instances which completed a scope (i.e., in BPMN 2.0 manner: a scope is completed by an activity instance when the activity instance consumed a token but did not emit a new token). Note: This only includes historic data.

get/history/process-definition/{id}/statistics

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/history/process-definition/{id}/statistics
  • Auth: HTTP basic

Path parameters

idstring required

The id of the process definition.

Query parameters

canceledboolean

Whether to include the number of canceled activity instances in the result or not. Valid values are true or false. Default: false.

finishedboolean

Whether to include the number of finished activity instances in the result or not. Valid values are true or false. Default: false.

completeScopeboolean

Whether to include the number of activity instances which completed a scope in the result or not. Valid values are true or false. Default: false.

incidentsboolean

Whether to include the number of incidents. Valid values are true or false. Default: false.

startedBeforestring date-time

Restrict to process instances that were started before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

startedAfterstring date-time

Restrict to process instances that were started after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

finishedBeforestring date-time

Restrict to process instances that were finished before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

finishedAfterstring date-time

Restrict to process instances that were finished after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

processInstanceIdInstring

Restrict to process instances with the given IDs. The IDs must be provided as a comma- separated list.

sortBy'activityId'

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

sortOrder'asc' | 'desc'

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.

Response

Request successful.

idstring nullable

The id of the activity the results are aggregated for.

instancesinteger nullable

The total number of all running instances of the activity.

canceledinteger nullable

The total number of all canceled instances of the activity. Note: Will be 0 (not null), if canceled activity instances were excluded.

finishedinteger nullable

The total number of all finished instances of the activity. Note: Will be 0 (not null), if finished activity instances were excluded.

completeScopeinteger nullable

The total number of all instances which completed a scope of the activity. Note: Will be 0 (not null), if activity instances which completed a scope were excluded.

openIncidentsinteger nullable

The total number of open incidents for the activity. Note: Will be 0 (not null), if incidents is set to false.

resolvedIncidentsinteger nullable

The total number of resolved incidents for the activity. Note: Will be 0 (not null), if incidents is set to false.

deletedIncidentsinteger nullable

The total number of deleted incidents for the activity. Note: Will be 0 (not null), if incidents is set to false.

Changes

No recorded changes to this operation across all 1 revision of this API.