Historic Activity Instance

Get List Count (POST)

Queries for the number of historic activity instances that fulfill the given parameters.

post/history/activity-instance/count

Request

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

Request body

activityInstanceIdstring nullable

Filter by activity instance id.

processInstanceIdstring nullable

Filter by process instance id.

processDefinitionIdstring nullable

Filter by process definition id.

executionIdstring nullable

Filter by the id of the execution that executed the activity instance.

activityIdstring nullable

Filter by the activity id (according to BPMN 2.0 XML).

activityNamestring nullable

Filter by the activity name (according to BPMN 2.0 XML).

activityTypestring nullable

Filter by activity type.

taskAssigneestring nullable

Only include activity instances that are user tasks and assigned to a given user.

finishedboolean nullable

Only include finished activity instances. Value may only be true, as false behaves the same as when the property is not set.

unfinishedboolean nullable

Only include unfinished activity instances. Value may only be true, as false behaves the same as when the property is not set.

canceledboolean nullable

Only include canceled activity instances. Value may only be true, as false behaves the same as when the property is not set.

completeScopeboolean nullable

Only include activity instances which completed a scope. Value may only be true, as false behaves the same as when the property is not set.

startedBeforestring date-time nullable

Restrict to instances that were started before the given 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.

startedAfterstring date-time nullable

Restrict to instances that were started after the given 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.

finishedBeforestring date-time nullable

Restrict to instances that were finished before the given 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.

finishedAfterstring date-time nullable

Restrict to instances that were finished after the given 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.

tenantIdInstring[] nullable

Must be a JSON array of Strings. An activity instance must have one of the given tenant ids.

withoutTenantIdboolean nullable

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

Response

Request successful.

countinteger

The number of matching instances.

Changes

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