Execution

Get Message Event Subscription

Retrieves a message event subscription for a given execution by id and a message name.

get/execution/{id}/messageSubscriptions/{messageName}

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/execution/{id}/messageSubscriptions/{messageName}
  • Auth: HTTP basic

Path parameters

idstring required

The id of the execution that holds the subscription.

messageNamestring required

The name of the message that the subscription corresponds to.

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.