Sign in
Historic Detail

Get Historic Detail

Retrieves a historic detail by id.

get/history/detail/{id}

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/history/detail/{id}
  • Auth: HTTP basic

Path parameters

idstring required

The id of the detail.

Query parameters

deserializeValueboolean

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.

Response

Request successful.

idstring nullable

The id of the historic detail.

typestring nullable

The type of the historic detail. Either formField for a submitted form field value or variableUpdate for variable updates.

processDefinitionKeystring nullable

The key of the process definition that this historic detail belongs to.

processDefinitionIdstring nullable

The id of the process definition that this historic detail belongs to.

processInstanceIdstring nullable

The id of the process instance the historic detail belongs to.

activityInstanceIdstring nullable

The id of the activity instance the historic detail belongs to.

executionIdstring nullable

The id of the execution the historic detail belongs to.

caseDefinitionKeystring nullable

The key of the case definition that this historic detail belongs to.

caseDefinitionIdstring nullable

The id of the case definition that this historic detail belongs to.

caseInstanceIdstring nullable

The id of the case instance the historic detail belongs to.

caseExecutionIdstring nullable

The id of the case execution the historic detail belongs to.

taskIdstring nullable

The id of the task the historic detail belongs to.

tenantIdstring nullable

The id of the tenant that this historic detail belongs to.

userOperationIdstring nullable

The id of user operation which links historic detail with user operation log entries.

timestring date-time nullable

The time when this historic detail occurred. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

removalTimestring date-time nullable

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.

rootProcessInstanceIdstring nullable

The process instance id of the root process instance that initiated the process containing this historic detail.

fieldIdstring nullable

The id of the form field.

Note: This property is only set for a HistoricVariableUpdate historic details. In these cases, the value of the type property is formField.

fieldValueobject

The submitted form field value. The value differs depending on the form field's type and on the deserializeValue parameter.

Note: This property is only set for a HistoricVariableUpdate historic details. In these cases, the value of the type property is formField.

variableNamestring nullable

The name of the variable which has been updated.

Note: This property is only set for a HistoricVariableUpdate historic details. In these cases, the value of the type property is variableUpdate.

variableInstanceIdstring nullable

The id of the associated variable instance.

Note: This property is only set for a HistoricVariableUpdate historic details. In these cases, the value of the type property is variableUpdate.

variableTypestring nullable

The value type of the variable.

Note: This property is only set for a HistoricVariableUpdate historic details. In these cases, the value of the type property is variableUpdate.

valueobject

The variable's value. Value differs depending on the variable's type and on the deserializeValues parameter.

Note: This property is only set for a HistoricVariableUpdate historic details. In these cases, the value of the type property is variableUpdate.

valueInfoobject

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.

Note: This property is only set for a HistoricVariableUpdate historic details. In these cases, the value of the type property is variableUpdate.

initialboolean nullable

Returns true for variable updates that contains the initial values of the variables.

Note: This property is only set for a HistoricVariableUpdate historic details. In these cases, the value of the type property is variableUpdate.

revisioninteger nullable

The revision of the historic variable update.

Note: This property is only set for a HistoricVariableUpdate historic details. In these cases, the value of the type property is variableUpdate.

errorMessagestring nullable

An error message in case a Java Serialized Object could not be de-serialized.

Note: This property is only set for a HistoricVariableUpdate historic details. In these cases, the value of the type property is variableUpdate.

Changes

No recorded changes to this operation across all 1 revision of this API.