Sign in
Event Subscription

Get List

Queries for event subscriptions that fulfill given parameters. The size of the result set can be retrieved by using the Get Event Subscriptions count method.

get/event-subscription

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/event-subscription
  • Auth: HTTP basic

Query parameters

eventSubscriptionIdstring

Only select subscription with the given id.

eventNamestring

Only select subscriptions for events with the given name.

eventType'message' | 'signal' | 'compensate' | 'conditional'

Only select subscriptions for events with the given type. Valid values: message, signal, compensate and conditional.

executionIdstring

Only select subscriptions that belong to an execution with the given id.

processInstanceIdstring

Only select subscriptions that belong to a process instance with the given id.

activityIdstring

Only select subscriptions that belong to an activity with the given id.

tenantIdInstring

Filter by a comma-separated list of tenant ids. Only select subscriptions that belong to one of the given tenant ids.

withoutTenantIdboolean

Only select subscriptions which have no tenant id. Value may only be true, as false is the default behavior.

includeEventSubscriptionsWithoutTenantIdboolean

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.

sortBy'created' | 'tenantId'

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

sortOrder'asc' | 'desc'

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

firstResultinteger

Pagination of results. Specifies the index of the first result to return.

maxResultsinteger

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Response

Request successful.

idstring nullable

The id of the event subscription.

eventTypestring nullable

The type of the event subscription.

eventNamestring nullable

The name of the event this subscription belongs to as defined in the process model.

executionIdstring nullable

The execution that is subscribed on the referenced event.

processInstanceIdstring nullable

The process instance this subscription belongs to.

activityIdstring nullable

The identifier of the activity that this event subscription belongs to. This could for example be the id of a receive task.

createdDatestring date-time nullable

The time this event subscription was created.

tenantIdstring nullable

The id of the tenant this event subscription belongs to. Can be null if the subscription belongs to no single tenant.

Changes

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