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

Method

GET /process-instance/{id}

Parameters

Path Parameters

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

Result

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

Name Value Description
id String The id of the process instance.
definitionId String The id of the process definition this instance belongs to.
businessKey String The business key of the process instance.
caseInstanceId String The id of the case instance associated with the process instance.
ended Boolean A flag indicating whether the process instance has ended or not. Deprecated: will always be false!
suspended Boolean A flag indicating whether the process instance is suspended or not.
tenantId String The tenant id of the process instance.

Response Codes

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

Example

Request

GET /process-instance/aProcessInstanceId

Response

{"id":"aProcessInstanceId",
"definitionId":"aProcDefId",
"businessKey":"aKey",
"caseInstanceId":"aCaseInstanceId",
"ended":false,
"suspended":false,
"tenantId":null}

On this Page: