Correlate 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
The message name as defined in the BPMN process
The correlation key of the message
variables objectnullable
The message variables as JSON document
Additional properties allowed.
the tenant for which the message is published
Responses
- 200
- 400
- 403
- 404
- 500
The message is correlated to one or more process instances
- application/json
- Schema
- Example (from schema)
Schema
The key of the correlated message
The tenant ID of the correlated message
The key of the first process instance the message correlated with
{
"messageKey": 0,
"tenantId": "string",
"processInstanceKey": 0
}
The provided data is not valid
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
Unauthorized
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
Not found
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
Internal server error
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}