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

    Type Alias MessageSubscriptionResult

    type MessageSubscriptionResult = {
        businessId: BusinessId | null;
        correlationKey: string | null;
        elementId: ElementId;
        elementInstanceKey: ElementInstanceKey | null;
        inboundConnectorType: string | null;
        lastUpdatedDate: string;
        messageName: string;
        messageSubscriptionKey: MessageSubscriptionKey;
        messageSubscriptionState: MessageSubscriptionStateEnum;
        messageSubscriptionType: MessageSubscriptionTypeEnum;
        processDefinitionId: ProcessDefinitionId;
        processDefinitionKey: ProcessDefinitionKey | null;
        processDefinitionName: string | null;
        processDefinitionVersion: number | null;
        processInstanceKey: ProcessInstanceKey | null;
        rootProcessInstanceKey: ProcessInstanceKey | null;
        tenantId: TenantId;
        toolName: string | null;
        toolProperties: { [key: string]: string };
    }
    Index
    businessId correlationKey elementId elementInstanceKey inboundConnectorType lastUpdatedDate messageName messageSubscriptionKey messageSubscriptionState messageSubscriptionType processDefinitionId processDefinitionKey processDefinitionName processDefinitionVersion processInstanceKey rootProcessInstanceKey tenantId toolName toolProperties
    businessId: BusinessId | null

    The business id inherited from the subscribing process instance when this message subscription was opened. It is null when the process instance has no business id, and for message start event subscriptions, which are not tied to a process instance.

    correlationKey: string | null

    The correlation key of the message subscription.

    elementId: ElementId

    The element ID associated with this message subscription.

    elementInstanceKey: ElementInstanceKey | null

    The element instance key associated with this message subscription. Only populated for intermediate event entities.

    inboundConnectorType: string | null

    Inbound connector type extracted from the inbound.type zeebe:property. Null when the property is absent.

    lastUpdatedDate: string

    The last updated date of the message subscription.

    messageName: string

    The name of the message associated with the message subscription.

    messageSubscriptionKey: MessageSubscriptionKey

    The message subscription key associated with this message subscription.

    messageSubscriptionState: MessageSubscriptionStateEnum
    messageSubscriptionType: MessageSubscriptionTypeEnum
    processDefinitionId: ProcessDefinitionId

    The process definition ID associated with this message subscription.

    processDefinitionKey: ProcessDefinitionKey | null

    The process definition key associated with this message subscription.

    processDefinitionName: string | null

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

    processDefinitionVersion: number | null

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

    processInstanceKey: ProcessInstanceKey | null

    The process instance key associated with this message subscription. Only populated for intermediate event entities.

    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.

    tenantId: TenantId
    toolName: string | null

    Tool name extracted from the io.camunda.tool:name zeebe:property. Null when the property is absent.

    toolProperties: { [key: string]: string }

    The subset of zeebe:properties extension properties whose keys start with the io.camunda.tool: prefix, extracted from the BPMN element associated with this subscription. Empty object when no matching properties are defined.

    Settings
    Member Visibility

    On This Page
    Properties