Skip to main content
Version: 8.10 (unreleased)

Type Alias: CorrelatedMessageSubscriptionFilter

type CorrelatedMessageSubscriptionFilter = object;

Correlated message subscriptions search filter.

Properties​

correlationKey?​

optional correlationKey?: StringFilterProperty;

The correlation key of the message.

correlationTime?​

optional correlationTime?: DateTimeFilterProperty;

The time when the message was correlated.

elementId?​

optional elementId?: StringFilterProperty;

The element ID that received the message.

elementInstanceKey?​

optional elementInstanceKey?: ElementInstanceKeyFilterProperty;

The element instance key that received the message.

messageKey?​

optional messageKey?: BasicStringFilterProperty;

The message key.

messageName?​

optional messageName?: StringFilterProperty;

The name of the message.

partitionId?​

optional partitionId?: IntegerFilterProperty;

The partition ID that correlated the message.

processDefinitionId?​

optional processDefinitionId?: StringFilterProperty;

The process definition ID associated with this correlated message subscription.

processDefinitionKey?​

optional processDefinitionKey?: ProcessDefinitionKeyFilterProperty;

The process definition key associated with this correlated message subscription. For intermediate message events, this only works for data created with 8.9 and later.

processInstanceKey?​

optional processInstanceKey?: ProcessInstanceKeyFilterProperty;

The process instance key associated with this correlated message subscription.

subscriptionKey?​

optional subscriptionKey?: MessageSubscriptionKeyFilterProperty;

The subscription key that received the message.

tenantId?​

optional tenantId?: StringFilterProperty;

The tenant ID associated with this correlated message subscription.