Type Alias SearchMessageSubscriptionsData

Type Declaration

• Optionalfilter?: {
      correlationKey?: StringFilterProperty;
      elementId?: StringFilterProperty;
      elementInstanceKey?: ElementInstanceKeyFilterProperty;
      lastUpdatedDate?: DateTimeFilterProperty;
      messageName?: StringFilterProperty;
      messageSubscriptionKey?: MessageSubscriptionKeyFilterProperty;
      messageSubscriptionState?: MessageSubscriptionStateFilterProperty;
      processDefinitionId?: StringFilterProperty;
      processDefinitionKey?: ProcessDefinitionKeyFilterProperty;
      processInstanceKey?: ProcessInstanceKeyFilterProperty;
      tenantId?: StringFilterProperty;
  }

  Message subscription search filter.

  • OptionalcorrelationKey?: StringFilterProperty

    The correlation key of the message subscription.

  • OptionalelementId?: StringFilterProperty

    The element ID associated with this message subscription.

  • OptionalelementInstanceKey?: ElementInstanceKeyFilterProperty

    The element instance key associated with this message subscription.

  • OptionallastUpdatedDate?: DateTimeFilterProperty

    The last updated date of the message subscription.

  • OptionalmessageName?: StringFilterProperty

    The name of the message associated with the message subscription.

  • OptionalmessageSubscriptionKey?: MessageSubscriptionKeyFilterProperty

    The message subscription key associated with this message subscription.

  • OptionalmessageSubscriptionState?: MessageSubscriptionStateFilterProperty

    The message subscription state.

  • OptionalprocessDefinitionId?: StringFilterProperty

    The process definition ID associated with this message subscription.

  • OptionalprocessDefinitionKey?: ProcessDefinitionKeyFilterProperty

    The process definition key associated with this correlated message subscription. This only works for data created with 8.9 and later.

  • OptionalprocessInstanceKey?: ProcessInstanceKeyFilterProperty

    The process instance key associated with this message subscription.

  • OptionaltenantId?: StringFilterProperty

    The unique external tenant ID.

• Optionalsort?: {
      field:
          | "messageSubscriptionKey"
          | "processDefinitionId"
          | "processInstanceKey"
          | "elementId"
          | "elementInstanceKey"
          | "messageSubscriptionState"
          | "lastUpdatedDate"
          | "messageName"
          | "correlationKey"
          | "tenantId";
      order?: SortOrderEnum;
  }[]

  Sort field criteria.