Get Message Event Subscription
Retrieves a message event subscription for a given execution by id and a message name.
Method
GET /execution/{id}/messageSubscriptions/{messageName}
Parameters
Path Parameters
| Name | Description |
|---|---|
| id | The id of the execution that holds the subscription. |
| messageName | The name of the message that the subscription corresponds to. |
Result
A JSON object with the following properties:
| Name | Description |
|---|---|
| id | The identifier of the event subscription. |
| eventType | The type of the event. message for message events. |
| eventName | The name of the event the subscription belongs to, as defined in the process model. |
| executionId | The id of the execution the subscription belongs to. |
| processInstanceId | The id of the process instance the subscription belongs to. |
| activityId | The id of the activity that the event subscription belongs to. Corresponds to the id in the process model. |
| tenantId | The id of the tenant the subscription belongs to. |
| createdDate | The time the subscription was created by the engine. Default format* yyyy-MM-dd'T'HH:mm:ss.SSSZ. |
* For further information, please see the documentation.
Response Codes
| Code | Media type | Description |
|---|---|---|
| 200 | application/json | Request successful. |
| 404 | application/json | A message subscription for the given name and execution does not exist. This may either mean that the execution does not exist, or that it is not subscribed on such a message. See the Introduction for the error response format. |
Example
Request
GET /execution/anExecutionId/messageSubscriptions/someMessage
Response
{"id": "anEventSubscriptionId",
"eventType": "message",
"eventName": "anEvent",
"executionId": "anExecutionId",
"processInstanceId": "aProcInstId",
"activityId": "anActivity",
"tenantId": null,
"createdDate": "2013-01-23T13:59:43.000+0200"}