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

    Type Alias MessageSubscriptionResult

    type MessageSubscriptionResult = {
        correlationKey: string | null;
        elementId: ElementId;
        elementInstanceKey: ElementInstanceKey | null;
        extensionProperties: { [key: string]: string };
        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;
    }
    Index

    Properties

    correlationKey elementId elementInstanceKey extensionProperties inboundConnectorType lastUpdatedDate messageName messageSubscriptionKey messageSubscriptionState messageSubscriptionType processDefinitionId processDefinitionKey processDefinitionName processDefinitionVersion processInstanceKey rootProcessInstanceKey tenantId toolName

    Properties

    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.

    extensionProperties: { [key: string]: string }

    The zeebe:properties extension properties extracted from the BPMN element associated with this subscription. Empty object when no properties are defined.

    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.

    Settings

    Member Visibility

    On This Page

    Properties