Correlate a message

POST 
/messages/correlation

Publishes a message and correlates it to a subscription. If correlation is successful it will return the first process instance key the message correlated with.

Request

application/json

Body

required

name string

The message name as defined in the BPMN process

correlationKey string

The correlation key of the message

variables objectnullable

The message variables as JSON document

property name* anynullable

Additional properties allowed.

tenantId stringnullable

the tenant for which the message is published

Responses

200

The message is correlated to one or more process instances

application/json

Schema

Schema

messageKey int64

The key of the correlated message

tenantId string

The tenant ID of the correlated message

processInstanceKey int64

The key of the first process instance the message correlated with

Example (from schema)

{
  "messageKey": 0,
  "tenantId": "string",
  "processInstanceKey": 0
}

400

The provided data is not valid

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

403

Unauthorized

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

Not found

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

Internal server error

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...