Historic Activity Instance

Get

Retrieves a historic activity instance by id, according to the HistoricActivityInstance interface in the engine.

get/history/activity-instance/{id}

Request

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

Path parameters

idstring required

The id of the historic activity instance to be retrieved.

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.