Skip to main content
POST
/
history
/
activity-instance
Get List (POST)
curl --request POST \
  --url http://{host}:{port}/{contextPath}/history/activity-instance \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "activityType": "userTask",
  "taskAssignee": "peter",
  "sorting": [
    {
      "sortBy": "activityId",
      "sortOrder": "asc"
    },
    {
      "sortBy": "executionId",
      "sortOrder": "desc"
    }
  ]
}'
[
  {
    "activityId": "anActivity",
    "activityName": "anActivityName",
    "activityType": "userTask",
    "assignee": "peter",
    "calledProcessInstanceId": "aHistoricCalledProcessInstanceId",
    "calledCaseInstanceId": null,
    "canceled": true,
    "completeScope": false,
    "durationInMillis": 2000,
    "endTime": "2013-04-23T18:42:43.000+0200",
    "executionId": "anExecutionId",
    "id": "aHistoricActivityInstanceId",
    "parentActivityInstanceId": "aHistoricParentActivityInstanceId",
    "processDefinitionId": "aProcDefId",
    "processInstanceId": "aProcInstId",
    "startTime": "2013-04-23T11:20:43.000+0200",
    "taskId": "aTaskId",
    "tenantId": null,
    "removalTime": "2018-02-10T14:33:19.000+0200",
    "rootProcessInstanceId": "aRootProcessInstanceId"
  }
]

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

​
firstResult
integer

Pagination of results. Specifies the index of the first result to return.

​
maxResults
integer

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Body

application/json

A historic activity instance query which defines a group of historic activity instances

​
activityInstanceId
string | null

Filter by activity instance id.

​
processInstanceId
string | null

Filter by process instance id.

​
processDefinitionId
string | null

Filter by process definition id.

​
executionId
string | null

Filter by the id of the execution that executed the activity instance.

​
activityId
string | null

Filter by the activity id (according to BPMN 2.0 XML).

​
activityName
string | null

Filter by the activity name (according to BPMN 2.0 XML).

​
activityType
string | null

Filter by activity type.

​
taskAssignee
string | null

Only include activity instances that are user tasks and assigned to a given user.

​
finished
boolean | null

Only include finished activity instances. Value may only be true, as false behaves the same as when the property is not set.

​
unfinished
boolean | null

Only include unfinished activity instances. Value may only be true, as false behaves the same as when the property is not set.

​
canceled
boolean | null

Only include canceled activity instances. Value may only be true, as false behaves the same as when the property is not set.

​
completeScope
boolean | null

Only include activity instances which completed a scope. Value may only be true, as false behaves the same as when the property is not set.

​
startedBefore
string<date-time> | null

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

​
startedAfter
string<date-time> | null

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

​
finishedBefore
string<date-time> | null

Restrict to 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.

​
finishedAfter
string<date-time> | null

Restrict to 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.

​
tenantIdIn
string[] | null

Must be a JSON array of Strings. An activity instance must have one of the given tenant ids.

​
withoutTenantId
boolean | null

Only include historic activity instances that belong to no tenant. Value may only be true, as false is the default behavior.

​
sorting
object[] | null

Apply sorting of the result

Response

Request successful.

​
id
string | null

The id of the activity instance.

​
parentActivityInstanceId
string | null

The id of the parent activity instance, for example a sub process instance.

​
activityId
string | null

The id of the activity that this object is an instance of.

​
activityName
string | null

The name of the activity that this object is an instance of.

​
activityType
string | null

The type of the activity that this object is an instance of.

​
processDefinitionKey
string | null

The key of the process definition that this activity instance belongs to.

​
processDefinitionId
string | null

The id of the process definition that this activity instance belongs to.

​
processInstanceId
string | null

The id of the process instance that this activity instance belongs to.

​
executionId
string | null

The id of the execution that executed this activity instance.

​
taskId
string | null

The id of the task that is associated to this activity instance. Is only set if the activity is a user task.

​
assignee
string | null

The assignee of the task that is associated to this activity instance. Is only set if the activity is a user task.

​
calledProcessInstanceId
string | null

The id of the called process instance. Is only set if the activity is a call activity and the called instance a process instance.

​
calledCaseInstanceId
string | null

The id of the called case instance. Is only set if the activity is a call activity and the called instance a case instance.

​
startTime
string<date-time> | null

The time the instance was started. 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.

​
endTime
string<date-time> | null

The time the instance ended. 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.

​
durationInMillis
integer | null

The time the instance took to finish (in milliseconds).

​
canceled
boolean | null

If true, this activity instance is canceled.

​
completeScope
boolean | null

If true, this activity instance did complete a BPMN 2.0 scope.

​
tenantId
string | null

The tenant id of the activity instance.

​
removalTime
string<date-time> | null

The time after which the activity instance should be removed by the History Cleanup job. 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.

​
rootProcessInstanceId
string | null

The process instance id of the root process instance that initiated the process containing this activity instance.