Method

POST

Parameters

|firstResult|Pagination of results. Specifies the index of the first result to return.
|maxResults|Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.
|deserializeValues| 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 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.

A JSON object with the following properties:

sortByMandatory. Sort the results lexicographically by a given criterion. Valid values are processInstanceId, variableName, variableType, variableRevision, formPropertyId, time, occurrence and tenantId.
sortOrderMandatory. Sort the results in a given order. Values may be asc for ascending order or desc for descending order.

|sortBy|Mandatory. Sort the results lexicographically by a given criterion. Valid values are processInstanceId, variableName, variableType, variableRevision, formPropertyId, time, occurrence and tenantId.|sortOrder|Mandatory. Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
|sortBy|Mandatory. Sort the results lexicographically by a given criterion. Valid values are processInstanceId, , variableType, variableRevision, formPropertyId, time, occurrence and tenantId.
|sortOrder|Mandatory. Sort the results in a given order. Values may be asc for ascending order or desc for descending order.

Result

A JSON array of historic detail objects.Each historic detail object has the following properties:

  • For further information, please see the .

Depending on the type of the historic detail it contains further properties. In case of an 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.
Name Value Description
——-
value String/Number/Boolean/Object


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

  • serializationDataFormat: The serialization format used to store the variable.
    |Name|Value|Description
    |——-
    |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.

  • 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

    Example

    POST /history/detail?firstResult=1&maxResults=10

    1. [
    2.   {
    3.     "type": "variableUpdate",
    4.     "id": "3cd79390-001a-11e7-8c6b-34f39ab71d4e",
    5.     "processDefinitionKey": "invoice",
    6.     "processInstanceId": "3cd597b7-001a-11e7-8c6b-34f39ab71d4e",
    7.     "activityInstanceId": "StartEvent_1:3cd7456e-001a-11e7-8c6b-34f39ab71d4e",
    8.     "executionId": "3cd597b7-001a-11e7-8c6b-34f39ab71d4e",
    9.     "caseDefinitionKey": null,
    10.     "caseDefinitionId": null,
    11.     "caseInstanceId": null,
    12.     "caseExecutionId": null,
    13.     "taskId": null,
    15.     "userOperationId": "3cd76c7f-001a-11e7-8c6b-34f39ab71d4e",
    16.     "time": "2017-03-03T15:03:54.000+0200",
    17.     "variableName": "amount",
    18.     "variableInstanceId": "3cd65b08-001a-11e7-8c6b-34f39ab71d4e",
    19.     "variableType": "Double",
    20.     "value": 30.0,
    21.     "valueInfo": {},
    22.     "revision": 0,
    23.     "errorMessage": null
    24.   },
    25.   {
    26.     "type": "variableUpdate",
    27.     "id": "3cd79392-001a-11e7-8c6b-34f39ab71d4e",
    28.     "processDefinitionId": "invoice:1:3c59899b-001a-11e7-8c6b-34f39ab71d4e",
    29.     "processInstanceId": "3cd597b7-001a-11e7-8c6b-34f39ab71d4e",
    30.     "activityInstanceId": "StartEvent_1:3cd7456e-001a-11e7-8c6b-34f39ab71d4e",
    31.     "executionId": "3cd597b7-001a-11e7-8c6b-34f39ab71d4e",
    32.     "caseDefinitionKey": null,
    33.     "caseDefinitionId": null,
    34.     "caseInstanceId": null,
    35.     "caseExecutionId": null,
    36.     "taskId": null,
    37.     "tenantId": null,
    38.     "userOperationId": "3cd76c7f-001a-11e7-8c6b-34f39ab71d4e",
    39.     "time": "2017-03-03T15:03:54.000+0200",
    40.     "variableName": "invoiceDocument",
    41.     "variableInstanceId": "3cd65b0a-001a-11e7-8c6b-34f39ab71d4e",
    42.     "variableType": "File",
    43.     "value": null,
    44.     "valueInfo": {
    45.       "mimeType": "application/pdf",
    46.       "filename": "invoice.pdf"
    47.     },
    48.     "revision": 0,
    49.     "errorMessage": null