Sign in
Historic Activity Instance

Get List

Queries for historic activity instances that fulfill the given parameters. The size of the result set can be retrieved by using the Get Historic Activity Instance Count method.

get/history/activity-instance

Request

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

Query parameters

sortBy'activityInstanceId' | 'instanceId' | 'executionId' | 'activityId' | 'activityName' | 'activityType' | 'startTime' | 'endTime' | 'duration' | 'definitionId' | 'occurrence' | 'tenantId'

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

sortOrder'asc' | 'desc'

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

firstResultinteger

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

maxResultsinteger

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

activityInstanceIdstring

Filter by activity instance id.

processInstanceIdstring

Filter by process instance id.

processDefinitionIdstring

Filter by process definition id.

executionIdstring

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

activityIdstring

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

activityNamestring

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

activityTypestring

Filter by activity type.

taskAssigneestring

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

finishedboolean

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

unfinishedboolean

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

canceledboolean

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

completeScopeboolean

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.

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

finishedBeforestring date-time

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.

finishedAfterstring date-time

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.

tenantIdInstring

Filter by a comma-separated list of ids. An activity instance must have one of the given tenant ids.

withoutTenantIdboolean

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

Response

Request successful.

idstring nullable

The id of the activity instance.

parentActivityInstanceIdstring nullable

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

activityIdstring nullable

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

activityNamestring nullable

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

activityTypestring nullable

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

processDefinitionKeystring nullable

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

processDefinitionIdstring nullable

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

processInstanceIdstring nullable

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

executionIdstring nullable

The id of the execution that executed this activity instance.

taskIdstring nullable

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

assigneestring nullable

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

calledProcessInstanceIdstring nullable

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

calledCaseInstanceIdstring nullable

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

startTimestring date-time nullable

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.

endTimestring date-time nullable

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.

durationInMillisinteger nullable

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

canceledboolean nullable

If true, this activity instance is canceled.

completeScopeboolean nullable

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

tenantIdstring nullable

The tenant id of the activity instance.

removalTimestring date-time nullable

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.

rootProcessInstanceIdstring nullable

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

Changes

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