Camunda 平台 develop (7.16)

Options

编辑此页

Execute Migration Plan

Executes a migration plan synchronously for multiple process instances. To execute a migration plan asynchronously, use the Execute Migration Plan Async (Batch) method.

For more information about the difference between synchronous and asynchronous execution of a migration plan, please refer to the related section of the user guide.

Method

POST /migration/execute

Parameters

Request Body

A JSON object with the following properties:

Name Description
migrationPlan The migration plan to execute. A JSON object corresponding to the migration plan interface in the engine as explained below.
processInstanceIds A list of process instance ids to migrate.
processInstanceQuery A process instance query like the request body described by POST /process-instance .
skipCustomListeners A boolean value to control whether execution listeners should be invoked during migration.
skipIoMappings A boolean value to control whether input/output mappings should be executed during migration.

The migration plan JSON object has the following properties:

Name Description
sourceProcessDefinitionId The id of the source process definition for the migration.
targetProcessDefinitionId The id of the target process definition for the migration.
instructions A list of migration instructions which map equal activities. Each migration instruction is a JSON object with the following properties:
Name Value Description
sourceActivityIds Array The activity ids from the source process definition being mapped.
targetActivityIds Array The activity ids from the target process definition being mapped.
updateEventTrigger Boolean Configuration flag whether event triggers defined are going to be update during migration.
variables A map of variables which will be set into the process instances' scope. Each key is a variable name and each value a JSON variable value object with the following properties:

Name Description
value The variable's value. For variables of type Object, the serialized value has to be submitted as a String value.

For variables of type File the value has to be submitted as Base64 encoded string.

type The value type of the variable.
valueInfo A JSON object containing additional, value-type-dependent properties.

For serialized variables of type Object, the following properties can be provided:

  • objectTypeName: A string representation of the object's type name.
  • serializationDataFormat: The serialization format used to store the variable.

For serialized variables of type File, the following properties can be provided:

  • filename: The name of the file. This is not the variable name but the name that will be used when downloading the file again.
  • mimetype: The MIME type of the file that is being uploaded.
  • encoding: The encoding of the file that is being uploaded.

The following property can be provided for all value types:

  • transient: Indicates whether the variable should be transient or not. See documentation for more informations.

Result

This method returns no content.

Response codes

Code Media type Description
204 Request successful.
400 application/json The provided migration plan is not valid, so an exception of type MigrationPlanValidationException is returned. See the Introduction for the error response format.
400 application/json The provided migration plan is not valid for a specific process instance it is applied to, so an exception of type MigratingProcessInstanceValidationException is returned. See the Introduction for the error response format.
400 application/json Invalid variable value, 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.
400 application/json In case additional parameters of the request are unexpected, an exception of type InvalidRequestException is returned. See the Introduction for the error response format.

Example

Request

POST /migration/execute

Request Body:

{
  "migrationPlan": {
    "sourceProcessDefinitionId": "aProcessDefinitionId1",
    "targetProcessDefinitionId": "aProcessDefinitionId2",
    "instructions": [
      {
        "sourceActivityIds": ["aUserTask"],
        "targetActivityIds": ["aUserTask"]
      },
      {
        "sourceActivityIds": ["anEvent"],
        "targetActivityIds": ["anotherEvent"],
        "updateEventTrigger": true
      }
    ],
    "variables": {
      "foo": {
        "type": "Object",
        "value": "[5,9]",
        "valueInfo": {
          "objectTypeName": "java.util.ArrayList",
          "serializationDataFormat": "application/json"
        }
      }
    }
  },
  "processInstanceIds": [
    "aProcessInstance",
    "anotherProcessInstance"
  ],
  "processInstanceQuery": {
    "processDefinitionId": "aProcessDefinitionId1"
  },
  "skipCustomListeners": true
}

Response

Status 204. No content.

目录: