Get Event Subscriptions Count

Queries for the number of event subscriptions that fulfill given parameters. Takes the same parameters as the Get Event Subscription method.

Method

GET /event-subscription/count

Parameters

Query Parameters

Name Description
eventSubscriptionId Only select subscription with the given id.
eventName Only select subscriptions for events with the given name.
eventType Only select subscriptions for events with the given type. Valid values: message, signal, compensate, and conditional.
executionId Only select subscriptions that belong to an execution with the given id.
processInstanceId Only select subscriptions that belong to a process instance with the given id.
activityId Only select subscriptions that belong to an activity with the given id.
tenantIdIn Filter by a comma-separated list of tenant ids. Only select subscriptions that belong to one of the given tenant ids.
withoutTenantId Only select subscriptions which have no tenant id. Value may only be true, as false is the default behavior.
includeEventSubscriptionsWithoutTenantId Select event subscriptions which have no tenant id. Can be used in combination with tenantIdIn parameter. Value may only be true, as false is the default behavior.

Result

A JSON object that contains the count as the only property.

Name Type Description
count Number The number of matching event subscriptions.

Response Codes

Code Media type Description
200 application/json Request successful.
400 application/json Returned if some of the query parameters are invalid. See the Introduction for the error response format.

Example

Request

GET /event-subscription/count

Response

{
  "count": 1
}

On this Page: