Skip to main content
Version: 8.9 (unreleased)

Type Alias: SearchMessageSubscriptionsData

type SearchMessageSubscriptionsData = object;

Defined in: gen/types.gen.ts:12415

Properties

body?

optional body: SearchQueryRequest & object;

Defined in: gen/types.gen.ts:12416

Type Declaration

filter?
optional filter: object;

Message subscription search filter.

filter.correlationKey?
optional correlationKey: StringFilterProperty;

The correlation key of the message subscription.

filter.elementId?
optional elementId: StringFilterProperty;

The element ID associated with this message subscription.

filter.elementInstanceKey?
optional elementInstanceKey: ElementInstanceKeyFilterProperty;

The element instance key associated with this message subscription.

filter.lastUpdatedDate?
optional lastUpdatedDate: DateTimeFilterProperty;

The last updated date of the message subscription.

filter.messageName?
optional messageName: StringFilterProperty;

The name of the message associated with the message subscription.

filter.messageSubscriptionKey?
optional messageSubscriptionKey: MessageSubscriptionKeyFilterProperty;

The message subscription key associated with this message subscription.

filter.messageSubscriptionState?
optional messageSubscriptionState: MessageSubscriptionStateFilterProperty;

The message subscription state.

filter.processDefinitionId?
optional processDefinitionId: StringFilterProperty;

The process definition ID associated with this message subscription.

filter.processDefinitionKey?
optional processDefinitionKey: ProcessDefinitionKeyFilterProperty;

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

filter.processInstanceKey?
optional processInstanceKey: ProcessInstanceKeyFilterProperty;

The process instance key associated with this message subscription.

filter.tenantId?
optional tenantId: StringFilterProperty;

The unique external tenant ID.

sort?
optional sort: object[];

Sort field criteria.


path?

optional path: never;

Defined in: gen/types.gen.ts:12477


query?

optional query: never;

Defined in: gen/types.gen.ts:12478


url

url: "/message-subscriptions/search";

Defined in: gen/types.gen.ts:12479