Skip to main content
Version: 8.10 (unreleased)

Type Alias: MessageSubscriptionFilter

type MessageSubscriptionFilter = object;

Message subscription search filter.

Properties​

correlationKey?​

optional correlationKey?: StringFilterProperty;

The correlation key of the message subscription.

elementId?​

optional elementId?: StringFilterProperty;

The element ID associated with this message subscription.

elementInstanceKey?​

optional elementInstanceKey?: ElementInstanceKeyFilterProperty;

The element instance key associated with this message subscription.

inboundConnectorType?​

optional inboundConnectorType?: StringFilterProperty;

Filter by inbound connector type extracted from the inbound.type zeebe:property.

lastUpdatedDate?​

optional lastUpdatedDate?: DateTimeFilterProperty;

The last updated date of the message subscription.

messageName?​

optional messageName?: StringFilterProperty;

The name of the message associated with the message subscription.

messageSubscriptionKey?​

optional messageSubscriptionKey?: MessageSubscriptionKeyFilterProperty;

The message subscription key associated with this message subscription.

messageSubscriptionState?​

optional messageSubscriptionState?: MessageSubscriptionStateFilterProperty;

The message subscription state.

messageSubscriptionType?​

optional messageSubscriptionType?: MessageSubscriptionTypeFilterProperty;

The type of message subscription to filter by. When omitted, both START_EVENT and PROCESS_EVENT are returned. Only available for data created with Camunda 8.10 or later.

processDefinitionId?​

optional processDefinitionId?: StringFilterProperty;

The process definition ID associated with this message subscription.

processDefinitionKey?​

optional processDefinitionKey?: ProcessDefinitionKeyFilterProperty;

The process definition key associated with this correlated message subscription. This only works for data created with 8.9 and later.

processDefinitionName?​

optional processDefinitionName?: StringFilterProperty;

The name of the process definition associated with this message subscription.

processDefinitionVersion?​

optional processDefinitionVersion?: IntegerFilterProperty;

The version of the process definition associated with this message subscription.

processInstanceKey?​

optional processInstanceKey?: ProcessInstanceKeyFilterProperty;

The process instance key associated with this message subscription.

tenantId?​

optional tenantId?: StringFilterProperty;

The unique external tenant ID.

toolName?​

optional toolName?: StringFilterProperty;

Filter by tool name extracted from the io.camunda.tool:name zeebe:property.