Process Instance

Correlate Message Async (POST)

Correlates a message asynchronously to executions that are waiting for this message. Messages will not be correlated to process definition-level start message events to start process instances.

post/process-instance/message-async

Request

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

Request body

messageNamestring nullable

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.

processInstanceIdsstring[] nullable

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.

variablesobject nullable

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

Response

Request successful.

idstring nullable

The id of the batch.

typestring nullable

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

totalJobsinteger nullable

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

jobsCreatedinteger nullable

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

batchJobsPerSeedinteger nullable

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).

invocationsPerBatchJobinteger nullable

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.

seedJobDefinitionIdstring nullable

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

monitorJobDefinitionIdstring nullable

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

batchJobDefinitionIdstring nullable

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

suspendedboolean nullable

Indicates whether this batch is suspended or not.

tenantIdstring nullable

The tenant id of the batch.

createUserIdstring nullable

The id of the user that created the batch.

startTimestring date-time nullable

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.cibseven.org/manual/2.1/reference/rest/overview/date-format/)

executionStartTimestring date-time nullable

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.cibseven.org/manual/2.1/reference/rest/overview/date-format/)

Changes

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