Historic Process Instance

Get Duration Report

Retrieves a report about the duration of completed process instances, grouped by a period. These reports include the maximum, minimum and average duration of all completed process instances which were started in a given period.

Note: This only includes historic data.

get/history/process-instance/report

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/history/process-instance/report
  • Auth: HTTP basic

Query parameters

reportTypestring required

Mandatory. Specifies the type of the report to retrieve. To retrieve a report about the duration of process instances, the value must be set to duration.

periodUnit'month' | 'quarter' required

Mandatory. Specifies the granularity of the report. Valid values are month and quarter.

processDefinitionIdInstring

Filter by process definition ids. Must be a comma-separated list of process definition ids.

processDefinitionKeyInstring

Filter by process definition keys. Must be a comma-separated list of process definition keys.

startedBeforestring date-time

Restrict to 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., 2016-01-23T14:42:45.000+0200.

startedAfterstring date-time

Restrict to 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., 2016-01-23T14:42:45.000+0200.

Response

Request successful.

periodinteger nullable

Specifies a timespan within a year. Note: The period must be interpreted in conjunction with the returned periodUnit.

periodUnit'MONTH' | 'QUARTER' nullable

The unit of the given period. Possible values are MONTH and QUARTER.

minimuminteger nullable

The smallest duration in milliseconds of all completed process instances which were started in the given period.

maximuminteger nullable

The greatest duration in milliseconds of all completed process instances which were started in the given period.

averageinteger nullable

The average duration in milliseconds of all completed process instances which were started in the given period.

Changes

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