Skip to main content
POST
/
migration
/
generate
Generate Migration Plan
curl --request POST \
  --url http://{host}:{port}/{contextPath}/migration/generate \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sourceProcessDefinitionId": "aProcessDefinitionId1",
  "targetProcessDefinitionId": "aProcessDefinitionId2",
  "updateEventTriggers": true,
  "variables": {
    "foo": {
      "type": "Object",
      "value": "[5,6]",
      "valueInfo": {
        "objectTypeName": "java.util.ArrayList",
        "serializationDataFormat": "application/json"
      }
    }
  }
}'
{
  "sourceProcessDefinitionId": "aProcessDefinitionId1",
  "targetProcessDefinitionId": "aProcessDefinitionId2",
  "instructions": [
    {
      "sourceActivityIds": [
        "aUserTask"
      ],
      "targetActivityIds": [
        "aUserTask"
      ],
      "updateEventTrigger": false
    },
    {
      "sourceActivityIds": [
        "anEvent"
      ],
      "targetActivityIds": [
        "anotherEvent"
      ],
      "updateEventTrigger": true
    }
  ],
  "variables": {
    "foo": {
      "type": "Object",
      "value": "[5,6]",
      "valueInfo": {
        "objectTypeName": "java.util.ArrayList",
        "serializationDataFormat": "application/json"
      }
    }
  }
}

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
​
sourceProcessDefinitionId
string | null

The id of the source process definition for the migration.

​
targetProcessDefinitionId
string | null

The id of the target process definition for the migration.

​
updateEventTriggers
boolean | null

A boolean flag indicating whether instructions between events should be configured to update the event triggers.

​
variables
object | null

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.

Response

Request successful.

​
sourceProcessDefinitionId
string | null

The id of the source process definition for the migration.

​
targetProcessDefinitionId
string | null

The id of the target process definition for the migration.

​
instructions
object[] | null

A list of migration instructions which map equal activities. Each migration instruction is a JSON object with the following properties:

​
variables
object | null

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.