Sign in
Message

Correlate

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.

post/message

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/message
  • Auth: HTTP basic

Request body

messageNamestring nullable

The name of the message to deliver.

businessKeystring nullable

Used for correlation of process instances that wait for incoming messages. Will only correlate to executions that belong to a process instance with the provided business key.

tenantIdstring nullable

Used to correlate the message for a tenant with the given id. Will only correlate to executions and process definitions which belong to the tenant. Must not be supplied in conjunction with a withoutTenantId.

withoutTenantIdboolean nullable

A Boolean value that indicates whether the message should only be correlated to executions and process definitions which belong to no tenant or not. Value may only be true, as false is the default behavior. Must not be supplied in conjunction with a tenantId.

processInstanceIdstring nullable

Used to correlate the message to the process instance with the given id.

correlationKeysobject nullable

Used for correlation of process instances that wait for incoming messages. Has to be a JSON object containing key-value pairs that are matched against process instance variables during correlation. Each key is a variable name and each value a JSON variable value object with the following properties.

localCorrelationKeysobject nullable

Local variables used for correlation of executions (process instances) that wait for incoming messages. Has to be a JSON object containing key-value pairs that are matched against local variables during correlation. Each key is a variable name and each value a JSON variable value object with the following properties.

processVariablesobject nullable

A map of variables that is injected into the triggered execution or process instance after the message has been delivered. Each key is a variable name and each value a JSON variable value object with the following properties.

processVariablesLocalobject nullable

A map of local variables that is injected into the execution waiting on the message. Each key is a variable name and each value a JSON variable value object with the following properties.

processVariablesToTriggeredScopeobject nullable

A map of variables that is injected into the new scope triggered by message correlation. Each key is a variable name and each value a JSON variable value object with the following properties.

allboolean nullable

A Boolean value that indicates whether the message should be correlated to exactly one entity or multiple entities. If the value is set to false, the message will be correlated to exactly one entity (execution or process definition). If the value is set to true, the message will be correlated to multiple executions and a process definition that can be instantiated by this message in one go.

resultEnabledboolean nullable

A Boolean value that indicates whether the result of the correlation should be returned or not. If this property is set to true, there will be returned a list of message correlation result objects. Depending on the all property, there will be either one ore more returned results in the list.

The default value is false, which means no result will be returned.

variablesInResultEnabledboolean nullable

A Boolean value that indicates whether the result of the correlation should contain process variables or not. The parameter resultEnabled should be set to true in order to use this it.

The default value is false, which means the variables will not be returned.

Response

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.

resultType'Execution' | 'ProcessDefinition' nullable

Indicates if the message was correlated to a message start event or an intermediate message catching event. In the first case, the resultType is ProcessDefinition and otherwise Execution.

variablesobject nullable

This property is returned if the variablesInResultEnabled is set to true. Contains a list of the process variables.

Changes

No recorded changes to this operation across all 1 revision of this API.