Camunda Platform 7.12

Options

Edit on Github

Get Historic Details (POST)

Queries for historic details that fulfill the given parameters. This method is slightly more powerful than the Get Historic Details method because it allows sorting by multiple parameters. The size of the result set can be retrieved by using the Get Historic Detail Count method.

Method

POST /history/detail

Parameters

Query 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 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.

Request

A JSON object with the following properties:

Name Description
processInstanceId Filter by process instance id.
processInstanceIdIn Only include historic details which belong to one of the passed process instance ids.
executionId Filter by execution id.
activityInstanceId Filter by activity instance id.
caseInstanceId Filter by case instance id.
caseExecutionId Filter by case execution id.
variableInstanceId Filter by variable instance id.
variableTypeIn Only include historic details where the variable updates belong to one of the passed and comma-separated variable types. A list of all supported variable types can be found here. Note: All non-primitive variables are associated with the type "serializable".
tenantIdIn Filter by a comma-separated list of tenant ids.
withoutTenantId Only include historic details that belong to no tenant. Value may only be true, as false is the default behavior.
userOperationId Filter by a user operation id
formFields Only include HistoricFormFields. Value may only be true, as false is the default behavior.
variableUpdates Only include HistoricVariableUpdates. Value may only be true, as false is the default behavior.
excludeTaskDetails Excludes all task-related HistoricDetails, so only items which have no task id set will be selected. When this parameter is used together with taskId, this call is ignored and task details are not excluded. Value may only be true, as false is the default behavior.
occurredBefore Restrict to historic details that occured before the given date (including the date). By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.
occurredAfter Restrict to historic details that occured after the given date (including the date). By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.
sorting A JSON array of criteria to sort the result by. Each element of the array is a JSON object that specifies one ordering. The position in the array identifies the rank of an ordering, i.e., whether it is primary, secondary, etc. The ordering objects have the following properties:
Name Description
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.

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 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 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.
value String/Number/Boolean/Object The variable's value. Value differs depending on the variable's type and on the deserializeValues parameter.
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.
400 application/json Returned if some of the query parameters are invalid, for example if a sortOrder parameter is supplied, but no sortBy. See the Introduction for the error response format.

Example

Request

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

Response Body:

{
  "processInstanceId": "3cd597b7-001a-11e7-8c6b-34f39ab71d4e",
  "occurredAfter": "2018-01-29T10:15:45.000+0100",
  "sorting": [
    {
      "sortBy": "processInstanceId",
      "sortOrder": "asc"
    }
  ]
}

Response

[
  {
    "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"
  },
  {
    "type": "variableUpdate",
    "id": "3cd79392-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": "invoiceDocument",
    "variableInstanceId": "3cd65b0a-001a-11e7-8c6b-34f39ab71d4e",
    "variableType": "File",
    "value": null,
    "valueInfo": {
      "mimeType": "application/pdf",
      "filename": "invoice.pdf"
    },
    "revision": 0,
    "errorMessage": null,
    "removalTime":"2018-02-10T14:33:19.000+0200",
    "rootProcessInstanceId": "aRootProcessInstanceId"
  }
]

On this Page: