Skip to main content
POST
/
migration
/
validate
Validate Migration Plan
curl --request POST \
  --url http://{host}:{port}/{contextPath}/migration/validate \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sourceProcessDefinitionId": "aProcessDefinitionId1",
  "targetProcessDefinitionId": "aProcessDefinitionId2",
  "instructions": [
    {
      "sourceActivityIds": [
        "aUserTask"
      ],
      "targetActivityIds": [
        "aUserTask"
      ]
    },
    {
      "sourceActivityIds": [
        "anEvent"
      ],
      "targetActivityIds": [
        "anotherEvent"
      ],
      "updateEventTrigger": true
    }
  ],
  "variables": {
    "foo": {
      "type": "Object",
      "value": "...",
      "valueInfo": {
        "objectTypeName": "java.util.ArrayList",
        "serializationDataFormat": "application/x-java-serialized-object"
      }
    }
  }
}'
{
  "instructionReports": [
    {
      "instruction": {
        "sourceActivityIds": [
          "aUserTask"
        ],
        "targetActivityIds": [
          "aUserTask"
        ],
        "updateEventTrigger": false
      },
      "failures": [
        "failure1",
        "failure2"
      ]
    },
    {
      "instruction": {
        "sourceActivityIds": [
          "anEvent"
        ],
        "targetActivityIds": [
          "anotherEvent"
        ],
        "updateEventTrigger": true
      },
      "failures": [
        "failure1",
        "failure2"
      ]
    }
  ],
  "variableReports": {
    "foo": {
      "type": "Object",
      "value": "...",
      "valueInfo": {
        "objectTypeName": "java.util.ArrayList",
        "serializationDataFormat": "application/x-java-serialized-object"
      },
      "failures": [
        "Cannot set variable with name foo. Java serialization format is prohibited"
      ]
    }
  }
}

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.

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

Response

Request successful. The validation report was returned.

​
instructionReports
object[] | null

The list of instruction validation reports. If no validation errors are detected it is an empty list.

​
variableReports
object | null

A map of variable reports. Each key is a variable name and each value a JSON object consisting of the variable's type, value, value info object and a list of failures.