Get Historic Case Instance

Retrieves a historic case instance by id, according to the HistoricCaseInstance interface in the engine.

Method

GET /history/case-instance/{id}

Parameters

Path Parameters

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

Result

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

Name	Value	Description
id	String	The id of the case instance.
businessKey	String	The business key of the case instance.
caseDefinitionName	String	The name of the case definition that this case instance belongs to.
caseDefinitionKey	String	The key of the case definition that this case instance belongs to.
caseDefinitionId	String	The id of the case definition that this case instance belongs to.
createTime	String	The time the instance was created. Default format* `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
closeTime	String	The time the instance was closed. Default format* `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
durationInMillis	Number	The time the instance took to finish (in milliseconds).
createUserId	String	The id of the user who created the case instance.
superCaseInstanceId	String	The id of the parent case instance, if it exists.
superProcessInstanceId	String	The id of the parent parent instance, if it exists.
tenantId	String	The tenant id of the case instance.
active	Boolean	If true, this case instance is active.
completed	Boolean	If true, this case instance is completed.
terminated	Boolean	If true, this case instance is terminated.
failed	Boolean	If true, this case instance is failed.
suspended	Boolean	If true, this case instance is suspended.
closed	Boolean	If true, this case instance is closed.

* For further information, please see the documentation.

Response Codes

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

Example

Request

GET /history/case-instance/aCaseInstId

Response

{
  "id": "aCaseInstId",
  "businessKey": "aKey",
  "caseDefinitionId": "aCaseDefId",
  "createTime": "2013-03-23T13:42:43.000+0200",
  "closeTime": "2013-03-23T13:42:45.000+0200",
  "durationInMillis": 2000,
  "createUserId": "aStartUserId",
  "superCaseInstanceId": "aSuperCaseInstanceId",
  "superProcessInstanceId": null,
  "tenantId": null,
  "active": true,
  "completed": false,
  "terminated": false,
  "failed": false,
  "suspended": false,
  "closed": false
}

Options