Historic Detail

Get Historic Detail Count

Queries for the number of historic details that fulfill the given parameters. Takes the same parameters as the Get Historic Details method.

get/history/detail/count

Request

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

Query parameters

processInstanceIdstring

Filter by process instance id.

processInstanceIdInstring

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

executionIdstring

Filter by execution id.

taskIdstring

Filter by task id.

activityInstanceIdstring

Filter by activity instance id.

caseInstanceIdstring

Filter by case instance id.

caseExecutionIdstring

Filter by case execution id.

variableInstanceIdstring

Filter by variable instance id.

variableTypeInstring

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.

variableNameLikestring

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

tenantIdInstring

Filter by a comma-separated list of tenant ids.

withoutTenantIdboolean

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

userOperationIdstring

Filter by a user operation id.

formFieldsboolean

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

variableUpdatesboolean

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

excludeTaskDetailsboolean

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

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

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

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.

countinteger

The number of matching instances.

Changes

No recorded changes to this operation across all 1 revision of this API.