Skip to main content
POST
/
history
/
detail
Get Historic Details (POST)
curl --request POST \
  --url http://{host}:{port}/{contextPath}/history/detail \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "processInstanceId": "3cd597b7-001a-11e7-8c6b-34f39ab71d4e",
  "occurredAfter": "2018-01-29T10:15:45.000+0100",
  "sorting": [
    {
      "sortBy": "processInstanceId",
      "sortOrder": "asc"
    }
  ]
}'
[
  {
    "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,
    "valueInfo": {},
    "revision": 0,
    "errorMessage": null,
    "removalTime": "2018-02-10T14:33:19.000+0200",
    "rootProcessInstanceId": "aRootProcessInstanceId",
    "initial": true
  },
  {
    "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",
    "initial": true
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
firstResult
integer

Pagination of results. Specifies the index of the first result to return.

​
maxResults
integer

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

​
deserializeValues
boolean

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.

Body

application/json

A historic detail query which defines a group of historic details.

​
processInstanceId
string | null

Filter by process instance id.

​
processInstanceIdIn
string[] | null

Only include historic details which belong to one of the passed process instance ids.

​
executionId
string | null

Filter by execution id.

​
taskId
string | null

Filter by task id.

​
activityInstanceId
string | null

Filter by activity instance id.

​
caseInstanceId
string | null

Filter by case instance id.

​
caseExecutionId
string | null

Filter by case execution id.

​
variableInstanceId
string | null

Filter by variable instance id.

​
variableTypeIn
string[] | null

Only include historic details where the variable updates belong to one of the passed list of variable types. A list of all supported variable types can be found here. Note: All non-primitive variables are associated with the type serializable.

​
variableNameLike
string | null

Filter by variable name like. Example usage: variableNameLike(%camunda%). The query will match the names of variables in a case-insensitive way.

​
tenantIdIn
string[] | null

Filter by a list of tenant ids.

​
withoutTenantId
boolean | null

Only include historic details that belong to no tenant. Value may only be true, as false is the default behavior.

​
userOperationId
string | null

Filter by a user operation id.

​
formFields
boolean | null

Only include HistoricFormFields. Value may only be true, as false is the default behavior.

​
variableUpdates
boolean | null

Only include HistoricVariableUpdates. Value may only be true, as false is the default behavior.

​
excludeTaskDetails
boolean | null

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.

​
initial
boolean | null

Restrict to historic variable updates that contain only initial variable values. Value may only be true, as false is the default behavior.

​
occurredBefore
string<date-time> | null

Restrict to historic details that occured before the given date (including the date). Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

​
occurredAfter
string<date-time> | null

Restrict to historic details that occured after the given date (including the date). Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

​
sorting
object[] | null

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. Does not have an effect for the count endpoint.

Response

Request successful.

​
id
string | null

The id of the historic detail.

​
type
string | null

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

​
processDefinitionKey
string | null

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

​
processDefinitionId
string | null

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

​
processInstanceId
string | null

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

​
activityInstanceId
string | null

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

​
executionId
string | null

The id of the execution the historic detail belongs to.

​
caseDefinitionKey
string | null

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

​
caseDefinitionId
string | null

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

​
caseInstanceId
string | null

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

​
caseExecutionId
string | null

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

​
taskId
string | null

The id of the task the historic detail belongs to.

​
tenantId
string | null

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

​
userOperationId
string | null

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

​
time
string<date-time> | null

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

​
removalTime
string<date-time> | null

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

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

​
fieldId
string | null

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.

​
fieldValue
object

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.

​
variableName
string | null

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.

​
variableInstanceId
string | null

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.

​
variableType
string | null

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.

​
value
object

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.

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

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

​
initial
boolean | null

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.

​
revision
integer | null

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.

​
errorMessage
string | null

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.