Skip to main content
GET
/
history
/
detail
/
count
Get Historic Detail Count
curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/detail/count \
  --header 'Authorization: Basic <encoded-value>'
{
  "count": 3
}

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

processInstanceId
string

Filter by process instance id.

processInstanceIdIn
string

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

executionId
string

Filter by execution id.

taskId
string

Filter by task id.

activityInstanceId
string

Filter by activity instance id.

caseInstanceId
string

Filter by case instance id.

caseExecutionId
string

Filter by case execution id.

variableInstanceId
string

Filter by variable instance id.

variableTypeIn
string

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.

variableNameLike
string

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

tenantIdIn
string

Filter by a comma-separated list of tenant ids.

withoutTenantId
boolean

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

userOperationId
string

Filter by a user operation id.

formFields
boolean

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

variableUpdates
boolean

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

excludeTaskDetails
boolean

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

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>

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>

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.

count
integer

The number of matching instances.