Skip to main content
GET
/
process-instance
/
{id}
Get Process Instance
curl --request GET \
  --url http://{host}:{port}/{contextPath}/process-instance/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "aProcessInstanceId",
  "definitionId": "aProcDefId",
  "businessKey": "aKey",
  "caseInstanceId": "aCaseInstanceId",
  "ended": false,
  "suspended": false,
  "tenantId": null
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The id of the process instance to be retrieved.

Response

Request successful.

​
id
string | null

The id of the process instance.

​
definitionId
string | null

The id of the process definition that this process instance belongs to.

​
businessKey
string | null

The business key of the process instance.

​
caseInstanceId
string | null

The id of the case instance associated with the process instance.

​
ended
boolean | null
deprecated

A flag indicating whether the process instance has ended or not. Deprecated: will always be false!

​
suspended
boolean | null

A flag indicating whether the process instance is suspended or not.

​
tenantId
string | null

The tenant id of the process instance.

​
links
object[] | null

The links associated to this resource, with method, href and rel.