Skip to main content
GET
/
execution
/
{id}
/
messageSubscriptions
/
{messageName}
Get Message Event Subscription
curl --request GET \
  --url http://{host}:{port}/{contextPath}/execution/{id}/messageSubscriptions/{messageName} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "anEventSubscriptionId",
  "eventType": "message",
  "eventName": "anEvent",
  "executionId": "anExecutionId",
  "processInstanceId": "aProcInstId",
  "activityId": "anActivity",
  "tenantId": null,
  "createdDate": "2013-01-23T13:59:43.000+0200"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The id of the execution that holds the subscription.

​
messageName
string
required

The name of the message that the subscription corresponds to.

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.