Skip to main content
Version: 8.9

Type Alias: CorrelatedMessageSubscriptionResult

type CorrelatedMessageSubscriptionResult = object;

Properties​

correlationKey​

correlationKey: string | null;

The correlation key of the message.

correlationTime​

correlationTime: string;

The time when the message was correlated.

elementId​

elementId: string;

The element ID that received the message.

elementInstanceKey​

elementInstanceKey: ElementInstanceKey | null;

The element instance key that received the message. It is null for start event subscriptions.

messageKey​

messageKey: MessageKey;

The message key.

messageName​

messageName: string;

The name of the message.

partitionId​

partitionId: number;

The partition ID that correlated the message.

processDefinitionId​

processDefinitionId: ProcessDefinitionId;

The process definition ID associated with this correlated message subscription.

processDefinitionKey​

processDefinitionKey: ProcessDefinitionKey;

The process definition key associated with this correlated message subscription.

processInstanceKey​

processInstanceKey: ProcessInstanceKey;

The process instance key associated with this correlated message subscription.

rootProcessInstanceKey​

rootProcessInstanceKey: ProcessInstanceKey | null;

The key of the root process instance. The root process instance is the top-level ancestor in the process instance hierarchy. This field is only present for data belonging to process instance hierarchies created in version 8.9 or later.

subscriptionKey​

subscriptionKey: MessageSubscriptionKey;

The subscription key that received the message.

tenantId​

tenantId: TenantId;

The tenant ID associated with this correlated message subscription.