Method

POST /history/variable-instance

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:

Result

A JSON array of historic variable instance objects.Each historic activity instance object has the following properties:

Response Codes

Example

POST /history/variable-instance

Request Body:

[
    "id": "someId",
    "name": "someVariable",
    "type": "Integer",
    "variableType": "integer",
    "value": 5,
    "processDefinitionKey": "aProcessDefinitionKey",
    "processDefinitionId": "aProcessDefinitionId",
    "processInstanceId": "aProcInstId",
    "executionId": "aExecutionId",
    "activityInstanceId": "aActivityInstId",
    "caseDefinitionKey": null,
    "caseInstanceId": null,
    "caseExecutionId": null,
    "taskId": null,
    "tenantId": null,
    "errorMessage": null