Search message subscriptions

POST

/v2/message-subscriptions/search

curl --request POST \
  --url http://localhost:8080/v2/message-subscriptions/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "filter": { "messageSubscriptionKey": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" }, "processDefinitionKey": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" }, "processDefinitionId": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" }, "processDefinitionName": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" }, "processDefinitionVersion": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" }, "processInstanceKey": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" }, "elementId": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" }, "elementInstanceKey": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" }, "messageSubscriptionState": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" }, "messageSubscriptionType": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" }, "messageName": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" }, "correlationKey": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" }, "toolName": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" }, "inboundConnectorType": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" }, "lastUpdatedDate": "example", "tenantId": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" } }, "sort": [ { "field": "example", "order": "ASC" } ], "page": { "limit": 100, "from": 1, "after": "example", "before": "example" } }'

• A local engine, as started by the quickstart

Available inEmbedded·Bundled·Cluster

AuthAuthenticated Bearer token or console session with X-CSRF-Token · requires history:read

The open message subscriptions of the caller’s tenant: message start events of deployed processes and the catches instances wait in. The filters are those of the statistics (/v2/process-definitions/statistics/message-subscriptions); sort by any 8.9 sort field and page with page.after or page.from. The engine keeps no update time for a subscription, so lastUpdatedDate is the time of the answer and a filter on it is refused with 400.

Authorizations

• bearerAuth
• sessionCookie
• csrfToken

Parameters

Header Parameters

x-tenant-id

string

>= 1 characters

Tenant selection. A principal bound to one tenant may omit it; if sent, it must equal that tenant (403 otherwise). A principal that may act in several tenants must send it on every request: without it the request is refused with 400, and a tenant it may not act in is refused with 403.

Request Body

Media typeapplication/json

object

filter

object

messageSubscriptionKey

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

processDefinitionKey

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

processDefinitionId

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

processDefinitionName

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

processDefinitionVersion

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

processInstanceKey

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

elementId

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

elementInstanceKey

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

messageSubscriptionState

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

messageSubscriptionType

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

messageName

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

correlationKey

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

toolName

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

inboundConnectorType

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

lastUpdatedDate

Refused with 400; subscriptions carry no update time.

tenantId

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

sort

Array<object>

object

field

required

string

order

string

default: ASC

Allowed values: ASC DESC

page

limit (at most 500, default 100) with after (the endCursor of the previous page) or from (an offset). With a sort or a from, every match is sorted and paged by position, and endCursor continues that order. before is not supported.

object

limit

integer

default: 100 >= 1 <= 500

from

integer

after

The endCursor of the previous page.

string

before

Not supported. Any value is rejected with 400.

string

Responses

200

One page of message subscriptions.

Media typeapplication/json

object

items

required

Array<object>

object

messageSubscriptionKey

required

Positive signed 64-bit entity key, written as a decimal string.

string

/^[1-9][0-9]*$/

messageSubscriptionType

required

string

Allowed values: START_EVENT PROCESS_EVENT

messageSubscriptionState

required

string

Allowed values: CREATED

processDefinitionKey

required

Positive signed 64-bit entity key, written as a decimal string.

string

/^[1-9][0-9]*$/

processDefinitionId

required

string

processDefinitionName

required

Part of the wire shape. This release always sends null.

null

processDefinitionVersion

required

integer

processInstanceKey

required

Any of:

string

Positive signed 64-bit entity key, written as a decimal string.

string

/^[1-9][0-9]*$/

null

null

rootProcessInstanceKey

required

Any of:

string

Positive signed 64-bit entity key, written as a decimal string.

string

/^[1-9][0-9]*$/

null

null

elementInstanceKey

required

Any of:

string

Positive signed 64-bit entity key, written as a decimal string.

string

/^[1-9][0-9]*$/

null

null

elementId

required

string

messageName

required

string

correlationKey

required

string | null

tenantId

required

string

toolName

required

Part of the wire shape. This release always sends null.

null

toolProperties

required

object

key

additional properties

string

inboundConnectorType

required

Part of the wire shape. This release always sends null.

null

lastUpdatedDate

required

An RFC 3339 timestamp.

string format: date-time

page

required

totalItems counts every match of the query across all pages, and hasMoreTotalItems is always false. Every page with items carries both cursors; paging with page.after = endCursor ends with an empty page.

object

totalItems

required

integer format: int64

hasMoreTotalItems

required

boolean

startCursor

required

Opaque, base64. Set on every page with items; null only on an empty page.

string | null format: base64

endCursor

required

Opaque, base64. Set on every page with items; pass it as page.after for the next page, which is empty once every item was seen. null only on an empty page.

string | null format: base64

Example

{
  "items": [
    {
      "messageSubscriptionKey": "2251799813685249",
      "messageSubscriptionType": "START_EVENT",
      "messageSubscriptionState": "CREATED",
      "processDefinitionKey": "2251799813685249",
      "processInstanceKey": "2251799813685249",
      "rootProcessInstanceKey": "2251799813685249",
      "elementInstanceKey": "2251799813685249"
    }
  ]
}

400

The request is malformed, or it uses a property or filter this release does not support.

Media typeapplication/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:invalid-argument",
  "title": "Bad Request",
  "status": 400,
  "detail": "entity key must be a positive int64 string",
  "instance": "/v2/process-instances/0"
}

401

No valid credential was presented.

Media typeapplication/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer credential is required",
  "instance": "/v2/message-subscriptions/search"
}

Headers

WWW-Authenticate

string

Allowed value: Bearer

403

The caller lacks the required permission, a tenant named in the request is not the caller’s tenant, or a cookie write has no valid CSRF token.

Media typeapplication/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The principal lacks the action this route requires",
  "instance": "/v2/message-subscriptions/search"
}

500

An internal failure. The details are never exposed.

Media typeapplication/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:internal",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "The request could not be completed",
  "instance": "/v2/message-subscriptions/search"
}

503

Backpressure, or a dependency is not ready. Retry with the same idempotency key.

Media typeapplication/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:unavailable",
  "title": "Service Unavailable",
  "status": 503,
  "detail": "The required engine service is not ready",
  "instance": "/v2/message-subscriptions/search"
}