Get Process Instance

Retrieves a historic process instance by id, according to the HistoricProcessInstance interface in the engine.

Method

GET /history/process-instance/{id}

Parameters

Path Parameters

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

Result

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

Name	Value	Description
id	String	The id of the process instance.
rootProcessInstanceId	String	The process instance id of the root process instance that initiated the process.
superProcessInstanceId	String	The id of the parent process instance, if it exists.
superCaseInstanceId	String	The id of the parent case instance, if it exists.
caseInstanceId	String	The id of the parent case instance, if it exists.
processDefinitionName	String	The name of the process definition that this process instance belongs to.
processDefinitionKey	String	The key of the process definition that this process instance belongs to.
processDefinitionVersion	Integer	The version of the process definition that this process instance belongs to.
processDefinitionId	String	The id of the process definition that this process instance belongs to.
businessKey	String	The business key of the process instance.
startTime	String	The time the instance was started. Default format* `yyyy-MM-dd’T’HH:mm:ss.SSSZ`.
endTime	String	The time the instance ended. Default format* `yyyy-MM-dd’T’HH:mm:ss.SSSZ`.
removalTime	String	The time after which the instance should be removed by the History Cleanup job. Default format* `yyyy-MM-dd’T’HH:mm:ss.SSSZ`.
durationInMillis	Number	The time the instance took to finish (in milliseconds).
startUserId	String	The id of the user who started the process instance.
startActivityId	String	The id of the initial activity that was executed (e.g., a start event).
deleteReason	String	The provided delete reason in case the process instance was canceled during execution.
tenantId	String	The tenant id of the process instance.
state	String	last state of the process instance, possible values are: ACTIVE - running process instance SUSPENDED - suspended process instances COMPLETED - completed through normal end event EXTERNALLY_TERMINATED - terminated externally, for instance through REST API INTERNALLY_TERMINATED - terminated internally, for instance by terminating boundary event

* For further information, please see the documentation.

Response Codes

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

Example

Request

GET /history/process-instance/aProcInstId

Response

{
  "id":"7c80cc8f-ef95-11e6-b6e6-34f39ab71d4e",
  "businessKey":null,
  "processDefinitionId":"invoice:1:7bf79f13-ef95-11e6-b6e6-34f39ab71d4e",
  "processDefinitionKey":"invoice",
  "processDefinitionName":"Invoice Receipt",
  "processDefinitionVersion":1,
  "startTime":"2017-02-10T14:33:19.000+0200",
  "endTime":null,
  "removalTime": null,
  "durationInMillis":null,
  "startUserId":null,
  "startActivityId":"StartEvent_1",
  "deleteReason":null,
  "rootProcessInstanceId": "f8259e5d-ab9d-11e8-8449-e4a7a094a9d6",
  "superProcessInstanceId":null,
  "superCaseInstanceId":null,
  "caseInstanceId":null,
  "tenantId":null,
  "state":"ACTIVE"
}

Options