Get Case Instance
Retrieves a case instance by id, according to the CaseInstance
interface in the engine.
Method
GET /case-instance/{id}
Parameters
Path Parameters
Name | Description |
---|---|
id | The id of the case instance to be retrieved. |
Result
A JSON object corresponding to the CaseInstance
interface in the engine.
Its properties are as follows:
Name | Value | Description |
---|---|---|
id | String | The id of the case instance. |
caseDefinitionId | String | The id of the case definition this instance belongs to. |
businessKey | String | The business key of the case instance. |
active | Boolean | A flag indicating whether the case instance is active or not. |
completed | Boolean | A flag indicating whether the case instance is completed or not. |
tenantId | String | The tenant id of the case instance. |
Response Codes
Code | Media type | Description |
---|---|---|
200 | application/json | Request successful. |
404 | application/json | Case instance with given id does not exist. See the Introduction for the error response format. |
Example
Request
GET /case-instance/aCaseInstanceId
Response
{
"id" : "aCaseInstanceId",
"caseDefinitionId" : "aCaseDefId",
"businessKey" : "aKey",
"active" : true,
"completed" : false,
"tenantId" : null
}