Skip to main content
POST
/
process-instance
/
message-async
Correlate Message Async (POST)
curl --request POST \
  --url http://{host}:{port}/{contextPath}/process-instance/message-async \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "messageName": "a-message-name",
  "processInstanceIds": [
    "b4d2ad98-7240-11e9-98b7-be5e0f7575b7"
  ],
  "processInstanceQuery": {
    "processDefinitionKey": "my-process-definition-key"
  },
  "variables": {
    "myVariableName": {
      "value": "myStringValue"
    }
  }
}'
{
  "id": "120b568d-724a-11e9-98b7-be5e0f7575b7",
  "type": "correlate-message",
  "totalJobs": 12,
  "batchJobsPerSeed": 100,
  "invocationsPerBatchJob": 1,
  "seedJobDefinitionId": "120b5690-724a-11e9-98b7-be5e0f7575b7",
  "monitorJobDefinitionId": "120b568f-724a-11e9-98b7-be5e0f7575b7",
  "batchJobDefinitionId": "120b568e-724a-11e9-98b7-be5e0f7575b7",
  "tenantId": "accounting",
  "suspended": false,
  "createUserId": null
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
messageName
string | null

The name of the message to correlate. Corresponds to the 'name' element of the message defined in BPMN 2.0 XML. Can be null to correlate by other criteria only.

​
processInstanceIds
string[] | null

A list of process instance ids that define a group of process instances to which the operation will correlate a message.

Please note that if processInstanceIds, processInstanceQuery and historicProcessInstanceQuery are defined, the resulting operation will be performed on the union of these sets.

​
processInstanceQuery
object

A process instance query which defines a group of process instances

​
historicProcessInstanceQuery
object

A historic process instance query which defines a group of historic process instances

​
variables
object | null

All variables the operation will set in the root scope of the process instances the message is correlated to.

Response

Request successful.

​
id
string | null

The id of the batch.

​
type
string | null

The type of the batch. See the User Guide for more information about batch types.

​
totalJobs
integer | null

The total jobs of a batch is the number of batch execution jobs required to complete the batch.

​
jobsCreated
integer | null

The number of batch execution jobs already created by the seed job.

​
batchJobsPerSeed
integer | null

The number of batch execution jobs created per seed job invocation. The batch seed job is invoked until it has created all batch execution jobs required by the batch (see totalJobs property).

​
invocationsPerBatchJob
integer | null

Every batch execution job invokes the command executed by the batch invocationsPerBatchJob times. E.g., for a process instance migration batch this specifies the number of process instances which are migrated per batch execution job.

​
seedJobDefinitionId
string | null

The job definition id for the seed jobs of this batch.

​
monitorJobDefinitionId
string | null

The job definition id for the monitor jobs of this batch.

​
batchJobDefinitionId
string | null

The job definition id for the batch execution jobs of this batch.

​
suspended
boolean | null

Indicates whether this batch is suspended or not.

​
tenantId
string | null

The tenant id of the batch.

​
createUserId
string | null

The id of the user that created the batch.

​
startTime
string<date-time> | null

The time the batch was started. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For further information, please see the [documentation] (https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/)

​
executionStartTime
string<date-time> | null

The time the batch execution was started, i.e., at least one batch job has been executed. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For further information, please see the [documentation] (https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/)