Authorization9

Batch7

Condition1

Decision Definition17

Decision Requirements Definition11

Deployment10

Engine1

Event Subscription2

Execution16

External Task18

Filter14

Group13

Historic Activity Instance5

Historic Batch7

Historic Decision Definition2

Historic Decision Instance5

Historic Decision Requirements Definition1

Historic Detail5

Historic External Task Log6

Historic Identity Link Log2

Historic Incident2

Historic Job Log6

Historic Process Definition3

Historic Process Instance10

Historic Task Instance5

Historic User Operation Log4

Historic Variable Instance7

History Cleanup4

Identity4

Incident6

Job15

Job Definition9

Message1

Metrics3

Migration4

Modification2

Process Definition46

Process Instance25

Process Instance Comment4

Schema Log2

Signal1

Task22

Task Attachment5

Task Comment6

Task Identity Link3

Task Local Variable7

Task Variable7

Telemetry3

Tenant14

User10

Variable Instance6

Version1

Historic Detail

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.

post/history/detail

Request

Base URL: http://localhost:8080/engine-rest
URL: http://localhost:8080/engine-rest/history/detail
Auth: HTTP basic

Query parameters

firstResultinteger

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

maxResultsinteger

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

deserializeValuesboolean

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 body

processInstanceIdstring nullable

Filter by process instance id.

processInstanceIdInstring[] nullable

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

executionIdstring nullable

Filter by execution id.

taskIdstring nullable

Filter by task id.

activityInstanceIdstring nullable

Filter by activity instance id.

caseInstanceIdstring nullable

Filter by case instance id.

caseExecutionIdstring nullable

Filter by case execution id.

variableInstanceIdstring nullable

Filter by variable instance id.

variableTypeInstring[] nullable

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.

variableNameLikestring nullable

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

tenantIdInstring[] nullable

Filter by a list of tenant ids.

withoutTenantIdboolean nullable

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

userOperationIdstring nullable

Filter by a user operation id.

formFieldsboolean nullable

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

variableUpdatesboolean nullable

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

excludeTaskDetailsboolean nullable

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.

initialboolean nullable

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

occurredBeforestring date-time nullable

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.

occurredAfterstring date-time nullable

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.

Response

Request successful.

idstring nullable

The id of the historic detail.

typestring nullable

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

processDefinitionKeystring nullable

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

processDefinitionIdstring nullable

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

processInstanceIdstring nullable

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

activityInstanceIdstring nullable

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

executionIdstring nullable

The id of the execution the historic detail belongs to.

caseDefinitionKeystring nullable

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

caseDefinitionIdstring nullable

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

caseInstanceIdstring nullable

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

caseExecutionIdstring nullable

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

taskIdstring nullable

The id of the task the historic detail belongs to.

tenantIdstring nullable

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

userOperationIdstring nullable

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

timestring date-time nullable

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

removalTimestring date-time nullable

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.

rootProcessInstanceIdstring nullable

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

fieldIdstring nullable

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.

fieldValueobject

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.

variableNamestring nullable

The name of the variable which has been updated.