Get Historic Activity Instance

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

Method

GET /history/activity-instance/{id}

Parameters

Path Parameters

Name	Description
id	The id of the historic activity instance to be retrieved.

Result

A JSON object corresponding to the HistoricActivityInstance interface in the engine. Its properties are as follows:

Name	Value	Description
id	String	The id of the activity instance.
parentActivityInstanceId	String	The id of the parent activity instance, for example a sub process instance.
activityId	String	The id of the activity that this object is an instance of.
activityName	String	The name of the activity that this object is an instance of.
activityType	String	The type of the activity that this object is an instance of.
processDefinitionKey	String	The key of the process definition that this activity instance belongs to.
processDefinitionId	String	The id of the process definition that this activity instance belongs to.
processInstanceId	String	The id of the process instance that this activity instance belongs to.
executionId	String	The id of the execution that executed this activity instance.
taskId	String	The id of the task that is associated to this activity instance. Is only set if the activity is a user task.
assignee	String	The assignee of the task that is associated to this activity instance. Is only set if the activity is a user task.
calledProcessInstanceId	String	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	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	The time the instance was started. Has the format `yyyy-MM-dd'T'HH:mm:ss`.
endTime	String	The time the instance ended. Has the format `yyyy-MM-dd'T'HH:mm:ss`.
durationInMillis	Number	The time the instance took to finish (in milliseconds).
canceled	Boolean	If true, this activity instance is canceled.
completeScope	Boolean	If true, this activity instance did complete a BPMN 2.0 scope.
tenantId	String	The tenant id of the activity instance.

Response Codes

Code	Media type	Description
200	application/json	Request successful.
404	application/json	Historic activity instance with given id does not exist. See the Introduction for the error response format.

Example

Request

GET /history/activity-instance/aActivityInstId

Response

{
  "id": "aActivityInstId",
  "activityId": "anActivity",
  "activityName": "anActivityName",
  "activityType": "userTask",
  "assignee": "peter",
  "calledProcessInstanceId": "aHistoricCalledProcessInstanceId",
  "calledCaseInstanceId": null,
  "canceled": true,
  "completeScope": false,
  "durationInMillis": 2000,
  "endTime": "2013-04-23T18:42:43",
  "executionId": "anExecutionId",
  "parentActivityInstanceId": "aHistoricParentActivityInstanceId",
  "processDefinitionId": "aProcDefId",
  "processInstanceId": "aProcInstId",
  "startTime": "2013-04-23T11:20:43",
  "taskId": "aTaskId",
  "tenantId":null
}

Options