Skip to main content
GET
/
history
/
task
/
report
Get Task Report (Historic)
curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/task/report \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "taskName": null,
    "processDefinitionId": "aProcessDefinitionId",
    "processDefinitionKey": "aProcessDefinitionKey",
    "processDefinitionName": "A Process Definition Name",
    "count": 42
  },
  {
    "taskName": null,
    "processDefinitionId": "anotherProcessDefinitionId",
    "processDefinitionKey": "anotherProcessDefinitionKey",
    "processDefinitionName": "Another Process Definition Name",
    "count": 9000
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
reportType
enum<string>

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.

Available options:
duration,
count
​
periodUnit
enum<string>

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

Available options:
MONTH,
QUARTER
​
completedBefore
string<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.

​
completedAfter
string<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.

​
groupBy
string

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.

​
taskName
string | null

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.

​
count
integer | null

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.

​
processDefinitionKey
string | null

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.

​
processDefinitionId
string | null

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.

​
processDefinitionName
string | null

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.

​
period
integer | null

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

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

​
periodUnit
enum<string> | null

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

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

Available options:
MONTH,
QUARTER
​
minimum
integer | null

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

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

​
maximum
integer | null

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

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

​
average
integer | null

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

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

​
tenantId
string | null

The id of the tenant.