Correlate

POST 
/message

Correlates a message to the process engine to either trigger a message start event or an intermediate message catching event. Internally this maps to the engine's message correlation builder methods MessageCorrelationBuilder#correlateWithResult() and MessageCorrelationBuilder#correlateAllWithResult(). For more information about the correlation behavior, see the Message Events section of the BPMN 2.0 Implementation Reference.

Request

Responses

200

Request successful. The property resultEnabled in the request body was true. The variables property is only returned, if the property variablesInResultEnablewas set totrue` in the request.

204

Request successful. The property resultEnabled in the request body was false (Default).

400

Returned if:

• no messageName was supplied
• both tenantId and withoutTenantId are supplied
• the message has not been correlated to exactly one entity (execution or process definition)
• the variable value or type is invalid, for example if the value could not be parsed to an Integer value or the passed variable type is not supported.

See the Introduction for the error response format.