Sign in
Process Definition

Get Process Instance Statistics

Retrieves runtime statistics of the process engine, grouped by process definitions. These statistics include the number of running process instances, optionally the number of failed jobs and also optionally the number of incidents either grouped by incident types or for a specific incident type. Note: This does not include historic data.

get/process-definition/statistics

Request

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

Query parameters

failedJobsboolean

Whether to include the number of failed jobs in the result or not. Valid values are true or false.

incidentsboolean

Valid values for this property are true or false. If this property has been set to true the result will include the corresponding number of incidents for each occurred incident type. If it is set to false, the incidents will not be included in the result. Cannot be used in combination with incidentsForType.

incidentsForTypestring

If this property has been set with any incident type (i.e., a string value) the result will only include the number of incidents for the assigned incident type. Cannot be used in combination with incidents. See the User Guide for a list of incident types.

rootIncidentsboolean

Valid values for this property are true or false. If this property has been set to true the result will include the corresponding number of root incidents for each occurred incident type. If it is set to false, the incidents will not be included in the result. Cannot be used in combination with incidentsForType or incidents.

Response

Request successful.

idstring nullable

The id of the process definition the results are aggregated for.

instancesinteger

The total number of running process instances of this process definition.

failedJobsinteger

The total number of failed jobs for the running instances. Note: Will be 0 (not null), if failed jobs were excluded.

@classstring nullable

The fully qualified class name of the data transfer object class. The class name might change in future releases.

Changes

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