Skip to main content
GET
/
event-subscription
Get List
curl --request GET \
  --url http://{host}:{port}/{contextPath}/event-subscription \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "anId",
    "eventType": "message",
    "eventName": "anEventName",
    "executionId": "anExecutionId",
    "processInstanceId": "aProcessInstanceId",
    "activityId": "anActivityId",
    "createdDate": "2020-04-20T15:23:12.229+0200",
    "tenantId": null
  },
  {
    "id": "anotherId",
    "eventType": "message",
    "eventName": "anotherEventName",
    "executionId": "anotherExecutionId",
    "processInstanceId": "anotherProcessInstanceId",
    "activityId": "anotherActivityId",
    "createdDate": "2020-04-20T15:20:12.229+0200",
    "tenantId": null
  }
]

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

​
eventSubscriptionId
string

Only select subscription with the given id.

​
eventName
string

Only select subscriptions for events with the given name.

​
eventType
enum<string>

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

Available options:
message,
signal,
compensate,
conditional
​
executionId
string

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

​
processInstanceId
string

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

​
activityId
string

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

​
tenantIdIn
string

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

​
withoutTenantId
boolean

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

​
includeEventSubscriptionsWithoutTenantId
boolean

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
enum<string>

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

Available options:
created,
tenantId
​
sortOrder
enum<string>

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.

Available options:
asc,
desc
​
firstResult
integer

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

​
maxResults
integer

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.

​
id
string | null

The id of the event subscription.

​
eventType
string | null

The type of the event subscription.

​
eventName
string | null

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

​
executionId
string | null

The execution that is subscribed on the referenced event.

​
processInstanceId
string | null

The process instance this subscription belongs to.

​
activityId
string | null

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

​
createdDate
string<date-time> | null

The time this event subscription was created.

​
tenantId
string | null

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