Get Historic Detail
Retrieves a historic detail by id.
Method
GET /history/detail/{id}
Parameters
Path Parameters
Name | Description |
---|---|
id | The id of the detail. |
Query Parameters
Name | Description |
---|---|
deserializeValue |
Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true ).
If set to If set to Note: While |
Result
An object having the following properties:
Name | Value | Description |
---|---|---|
id | String | The id of the historic detail. |
type | String | The type of the historic detail. Either formField for a submitted form field value or variableUpdate for variable updates. |
processDefinitionKey | String | The key of the process definition that this historic detail belongs to. |
processDefinitionId | String | The id of the process definition that this historic detail belongs to. |
processInstanceId | String | The id of the process instance the historic detail belongs to. |
activityInstanceId | String | The id of the execution the historic detail belongs to. |
executionId | String | The id of the execution the historic detail belongs to. |
caseDefinitionKey | String | The key of the case definition that this historic detail belongs to. |
caseDefinitionId | String | The id of the case definition that this historic detail belongs to. |
caseInstanceId | String | The id of the case instance the historic detail belongs to. |
caseExecutionId | String | The id of the case execution the historic detail belongs to. |
taskId | String | The id of the task the historic detail belongs to. |
tenantId | String | The id of the tenant that this historic detail belongs to. |
time | String | The time when this historic detail occurred, has the format yyyy-MM-dd'T'HH:mm:ss . |
Depending on the type of the historic detail it contains further properties. In case of a HistoricVariableUpdate
the following properties are also provided:
Name | Value | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
variableName | String | The name of the variable which has been updated. | ||||||||||||
variableInstanceId | String | The id of the associated variable instance. | ||||||||||||
variableType | String | The value type of the variable. | ||||||||||||
value | String/Number/Boolean/Object |
|
||||||||||||
valueInfo | Object | A JSON object containing additional, value-type-dependent properties.
For variables of type
|
||||||||||||
revision | number | The revision of the historic variable update. | ||||||||||||
errorMessage | String | An error message in case a Java Serialized Object could not be de-serialized. |
In case of an HistoricFormField
the following properties are also provided:
Name | Value | Description |
---|---|---|
fieldId | String | The id of the form field. |
fieldValue | String/Number/Boolean/Object | The submitted value. |
Response Codes
Code | Media type | Description |
---|---|---|
200 | application/json | Request successful. |
404 | application/json | Variable with given id does not exist. See the Introduction for the error response format. |
Example
Request
GET /history/detail/someId
Response
Status 200.
{
"id": "12345",
"processInstanceId": "aProcInstId",
"activityInstanceId": "anActInstId",
"executionId": "anExecutionId",
"caseInstanceId": null,
"caseExecutionId": null,
"time": "2014-02-28T15:00:00",
"variableName": "myProcessVariable",
"variableInstanceId": "aVariableInstanceId",
"variableType": "String",
"value": "aVariableValue",
"revision": 1,
"errorMessage": null,
"tenantId": null
}