Authorization9

Batch7

Condition1

Decision Definition17

Decision Requirements Definition11

Deployment10

Engine1

Event Subscription2

Execution16

External Task18

Filter14

Group13

Historic Activity Instance5

Historic Batch7

Historic Decision Definition2

Historic Decision Instance5

Historic Decision Requirements Definition1

Historic Detail5

Historic External Task Log6

Historic Identity Link Log2

Historic Incident2

Historic Job Log6

Historic Process Definition3

Historic Process Instance10

Historic Task Instance5

Historic User Operation Log4

Historic Variable Instance7

History Cleanup4

Identity4

Incident6

Job15

Job Definition9

Message1

Metrics3

Migration4

Modification2

Process Definition46

Process Instance25

Process Instance Comment4

Schema Log2

Signal1

Task22

Task Attachment5

Task Comment6

Task Identity Link3

Task Local Variable7

Task Variable7

Telemetry3

Tenant14

User10

Variable Instance6

Version1

Historic Task Instance

Get Task Report (Historic)

Retrieves a report of completed tasks. When the report type is set to count, the report contains a list of completed task counts where an entry contains the task name, the definition key of the task, the process definition id, the process definition key, the process definition name and the count of how many tasks were completed for the specified key in a given period. When the report type is set to duration, the report contains a minimum, maximum and average duration value of all completed task instances in a given period.

get/history/task/report

Request

Base URL: http://localhost:8080/engine-rest
URL: http://localhost:8080/engine-rest/history/task/report
Auth: HTTP basic

Query parameters

reportType'duration' | 'count'

Mandatory. Specifies the kind of the report to execute. To retrieve a report about the duration of process instances the value must be set to duration. For a report of the completed tasks in a specific timespan the value must be set to count.

periodUnit'MONTH' | 'QUARTER'

When the report type is set to duration, this parameter is mandatory. Specifies the granularity of the report. Valid values are month and quarter.

completedBeforestring date-time

Restrict to tasks that were completed 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.

completedAfterstring date-time

Restrict to tasks that were completed 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.

groupBystring

When the report type is set to count, this parameter is mandatory. Groups the tasks report by a given criterion. Valid values are taskName and processDefinition.

Response

Request successful.

taskNamestring nullable

The name of the task. It is only available when the groupBy parameter is set to taskName. Else the value is null.

Note: This property is only set for a historic task report object. In these cases, the value of the reportType query parameter is count.

countinteger nullable

The number of tasks which have the given definition.

Note: This property is only set for a historic task report object. In these cases, the value of the reportType query parameter is count.

processDefinitionKeystring nullable

The key of the process definition.

Note: This property is only set for a historic task report object. In these cases, the value of the reportType query parameter is count.

processDefinitionIdstring nullable

The id of the process definition.

Note: This property is only set for a historic task report object. In these cases, the value of the reportType query parameter is count.

processDefinitionNamestring nullable

The name of the process definition.

Note: This property is only set for a historic task report object. In these cases, the value of the reportType query parameter is count.

periodinteger nullable

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