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.
Method
GET /history/detail/count
Parameters
Query Parameters
| Name | Description | |
|---|---|---|
| processInstanceId | Filter by process instance id. | |
| processInstanceIdIn | Only include historic details which belong to one of the passed process instance ids. | |
| executionId | Filter by execution id. | |
| taskId | Filter by task id. | |
| activityInstanceId | Filter by activity instance id. | |
| caseInstanceId | Filter by case instance id. | |
| caseExecutionId | Filter by case execution id. | |
| variableInstanceId | Filter by variable instance id. | |
| variableTypeIn | Only include historic details where the variable updates belong to one of the passed and comma-separated variable types. A list of all supported variable types can be found here. Note: All non-primitive variables are associated with the type "serializable". | |
| tenantIdIn | Filter by a comma-separated list of tenant ids. | |
| withoutTenantId | Only include historic details that belong to no tenant. Value may only be
true, as false is the default behavior. |
|
| userOperationId | Filter by a user operation id | formFields | Only include HistoricFormFields. Value may only be true, as false is the default behavior. |
| variableUpdates | Only include HistoricVariableUpdates. Value may only be true, as false is the default behavior. |
|
| excludeTaskDetails | 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 | Restrict to historic details that occured before the given date (including the date). By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200. |
|
| occurredAfter | Restrict to historic details that occured after the given date (including the date). By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200. |
Result
A JSON object that contains the count as the only property.
| Name | Value | Description |
|---|---|---|
| count | Number | The number of matching historic details. |
Response Codes
| Code | Media type | Description |
|---|---|---|
| 200 | application/json | Request successful. |
| 400 | application/json | Returned if some of the query parameters are invalid. |
Example
Request
GET /history/detail/count?variableName=my_variable
Response
{
"count": 3
}