Get Single Case Activity Instance (Historic)

Retrieves a single historic case activity instance according to the HistoricCaseActivityInstance interface in the engine.

Method

GET /history/case-activity-instance/{id}

Parameters

Path Parameters

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

Result

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

Name Value Description
id String The id of the case activity instance.
parentCaseActivityInstanceId String The id of the parent case activity instance.
caseActivityId String The id of the case activity that this object is an instance of.
caseActivityName String The name of the case activity that this object is an instance of.
caseActivityType String The type of the activity this case execution belongs to.
caseDefinitionId String The id of the case definition that this case activity instance belongs to.
caseInstanceId String The id of the case instance that this case activity instance belongs to.
caseExecutionId String The id of the case execution that executed this case activity instance.
taskId String The id of the task that is associated to this case activity instance. Is only set if the case activity is a human task.
calledProcessInstanceId String The id of the called process instance. Is only set if the case activity is a process task.
calledCaseInstanceId String The id of the called case instance. Is only set if the case activity is a case task.
createTime String The time the instance was created. 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).
required Boolean If true, this case activity instance is required.
repeatable Boolean If true, this case activity instance is repeatable.
repetition Boolean If true, this case activity instance is a repetition.
available Boolean If true, this case activity instance is available.
enabled Boolean If true, this case activity instance is enabled.
disabled Boolean If true, this case activity instance is disabled.
active Boolean If true, this case activity instance is active.
failed Boolean If true, this case activity instance is failed.
suspended Boolean If true, this case activity instance is suspended.
completed Boolean If true, this case activity instance is completed.
terminated Boolean If true, this case activity instance is terminated.
tenantId String The tenant id of the case activity instance.

Response Codes

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

Example

Request

GET /history/case-activity-instance/aCaseActivityInstId

Response

{
  "active": false,
  "available": true,
  "calledCaseInstanceId": "aHistoricCalledCaseInstanceId",
  "calledProcessInstanceId": "aHistoricCalledProcessInstanceId",
  "caseActivityId": "aCaseActivity",
  "caseActivityName": "aCaseActivityName",
  "caseDefinitionId": "aCaseDefId",
  "caseExecutionId": "aCaseExecutionId",
  "caseInstanceId": "aCaseInstId",
  "completed": false,
  "createTime": "2013-04-23T11:20:43",
  "disabled": false,
  "durationInMillis": 2000,
  "enabled": false,
  "endTime": "2013-04-23T18:42:43",
  "failed": false,
  "id": "aCaseActivityInstId",
  "parentCaseActivityInstanceId": "aHistoricParentCaseActivityInstanceId",
  "suspended": false,
  "taskId": "aTaskId",
  "terminated": false,
  "required": false,
  "repeatable": true,
  "repetition": false,
  "tenantId": null
}

On this Page: