@camunda8/orchestration-cluster-api
    Preparing search index...

    Type Alias CorrelatedMessageSubscriptionResult

    type CorrelatedMessageSubscriptionResult = {
        businessId: BusinessId | null;
        correlationKey: string | null;
        correlationTime: string;
        elementId: string;
        elementInstanceKey: ElementInstanceKey | null;
        messageKey: MessageKey;
        messageName: string;
        partitionId: number;
        processDefinitionId: ProcessDefinitionId;
        processDefinitionKey: ProcessDefinitionKey;
        processInstanceKey: ProcessInstanceKey;
        rootProcessInstanceKey: ProcessInstanceKey | null;
        subscriptionKey: MessageSubscriptionKey;
        tenantId: TenantId;
    }
    Index
    businessId correlationKey correlationTime elementId elementInstanceKey messageKey messageName partitionId processDefinitionId processDefinitionKey processInstanceKey rootProcessInstanceKey subscriptionKey tenantId
    businessId: BusinessId | null

    The business id associated with this correlated message subscription. For a message start event correlation, it is the business id carried by the correlating message that was stamped on the started process instance to enforce its uniqueness. For a catch, boundary, or intermediate event correlation, it is the business id of the subscribing process instance, captured when the subscription was opened. It is null when the relevant process instance has no business id.

    correlationKey: string | null

    The correlation key of the message.

    correlationTime: string

    The time when the message was correlated.

    elementId: string

    The element ID that received the message.

    elementInstanceKey: ElementInstanceKey | null

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

    messageKey: MessageKey

    The message key.

    messageName: string

    The name of the message.

    partitionId: number

    The partition ID that correlated the message.

    processDefinitionId: ProcessDefinitionId

    The process definition ID associated with this correlated message subscription.

    processDefinitionKey: ProcessDefinitionKey

    The process definition key associated with this correlated message subscription.

    processInstanceKey: ProcessInstanceKey

    The process instance key associated with this correlated message subscription.

    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: MessageSubscriptionKey

    The subscription key that received the message.

    tenantId: TenantId

    The tenant ID associated with this correlated message subscription.

    Settings
    Member Visibility

    On This Page
    Properties