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. |
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. |
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. 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). |
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:
|
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": "aProcInstId",
"businessKey": "aKey",
"processDefinitionId": "aProcDefId",
"startTime": "2013-03-23T13:42:43",
"endTime": "2013-03-23T13:42:45",
"durationInMillis": 2000,
"startUserId": "aStartUserId",
"startActivityId": "aStartActivityId",
"deleteReason": "aDeleteReason",
"superProcessInstanceId": "aSuperProcessInstanceId",
"superCaseInstanceId": null,
"caseInstanceId": "aCaseInstanceId",
"tenantId":null,
"state": "aState"
}