Method

GET

Parameters

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using 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 when developing web applications that are independent of the Java process applications deployed to the engine.

Result

A JSON array of historic detail objects.Each historic detail object has 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 entries.
time String The time when this historic detail occurred, default format* yyyy-MM-dd'T'HHss.SSSZ.

NameValueDescription
valueString / Number / Boolean / Object The variable's value. Value differs depending on the variable's type and on the deserializeValues parameter.
typeStringThe value type of the variable.
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.

|value|String / Number / Boolean / Object| The variable's value. Value differs depending on the variable's type and on the deserializeValues 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.

  • 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:

  • 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:

    Response Codes

    Code Media type Description
    200 application/json Request successful.
    400 application/json Returned if some of the query parameters are invalid, for example if a sortOrder parameter is supplied, but no . See the Introduction for the error response format.

    Example

    GET /history/detail?processInstanceId=3cd597b7-001a-11e7-8c6b-34f39ab71d4e