Get Historic Details

Filter by process instance id.

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

Filter by execution id.

Filter by task id.

Filter by activity instance id.

Filter by case instance id.

Filter by case execution id.

Filter by variable instance id.

Only include historic details where the variable updates belong to one of the passed comma-separated 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.

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

Filter by a comma-separated list of tenant ids.

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

Filter by a user operation id.

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

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

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.

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

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.

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.

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

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

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

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.