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 `true`, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine.

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.
userOperationId	String	The id of user operation which links historic detail with user operation log entries.
time	String	The time when this historic detail occurred, default format* `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
removalTime	String	The time after which the historic detail should be removed by the History Cleanup job. Default format* `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
rootProcessInstanceId	String	The process instance id of the root process instance that initiated the process containing this historic detail.

* For further information, please see the documentation.

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

Name	Value	Description
value	String / Number / Boolean / Object	The variable's value. Value differs depending on the variable's type and on the `deserializeValue` parameter.
type	String	The value type of the variable.
valueInfo	Object	A JSON object containing additional, value-type-dependent properties. For variables of type `Object`, the following properties are returned: `objectTypeName`: A string representation of the object's type name. `serializationDataFormat`: The serialization format used to store the variable.

valueInfo

Object

A JSON object containing additional, value-type-dependent properties.

For variables of type Object, the following properties are returned:

objectTypeName: A string representation of the object's type name.
serializationDataFormat: The serialization format used to store the variable.

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/3cd79390-001a-11e7-8c6b-34f39ab71d4e

Response

Status 200.

{
  "type": "variableUpdate",
  "id": "3cd79390-001a-11e7-8c6b-34f39ab71d4e",
  "processDefinitionKey": "invoice",
  "processDefinitionId": "invoice:1:3c59899b-001a-11e7-8c6b-34f39ab71d4e",
  "processInstanceId": "3cd597b7-001a-11e7-8c6b-34f39ab71d4e",
  "activityInstanceId": "StartEvent_1:3cd7456e-001a-11e7-8c6b-34f39ab71d4e",
  "executionId": "3cd597b7-001a-11e7-8c6b-34f39ab71d4e",
  "caseDefinitionKey": null,
  "caseDefinitionId": null,
  "caseInstanceId": null,
  "caseExecutionId": null,
  "taskId": null,
  "tenantId": null,
  "userOperationId": "3cd76c7f-001a-11e7-8c6b-34f39ab71d4e",
  "time": "2017-03-03T15:03:54.000+0200",
  "variableName": "amount",
  "variableInstanceId": "3cd65b08-001a-11e7-8c6b-34f39ab71d4e",
  "variableType": "Double",
  "value": 30.0,
  "valueInfo": {},
  "revision": 0,
  "errorMessage": null,
  "removalTime":"2018-02-10T14:33:19.000+0200",
  "rootProcessInstanceId": "aRootProcessInstanceId"
}

Options