Generate Migration Plan

Generate a migration plan for two process definitions. The generated migration plan contains migration instructions which map equal activities between the two process definitions.

Method

POST /migration/generate

Parameters

Request Body

A JSON object with 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.
updateEventTriggers A boolean flag indicating whether instructions between events should be configured to update the event triggers.

Result

A JSON object corresponding to the migration plan interface in the engine. Its properties are as follows:

Name Value Description
sourceProcessDefinitionId String The id of the source process definition for the migration.
targetProcessDefinitionId String The id of the target process definition for the migration.
instructions Array 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 updated during migration.

Response codes

Code Media type Description
200 application/json Request successful.
400 application/json The requested migration was invalid. See Introduction for the error response format.

Example

Request

POST /migration/generate

Request Body:

{
  "sourceProcessDefinitionId": "aProcessDefinitionId1",
  "targetProcessDefinitionId": "aProcessDefinitionId2",
  "updateEventTriggers": true
}

Response

Status 200.

{
  "sourceProcessDefinitionId": "aProcessDefinitionId1",
  "targetProcessDefinitionId": "aProcessDefinitionId2",
  "instructions": [
    {
      "sourceActivityIds": ["aUserTask"],
      "targetActivityIds": ["aUserTask"],
      "updateEventTrigger": false
    },
    {
      "sourceActivityIds": ["anEvent"],
      "targetActivityIds": ["anotherEvent"],
      "updateEventTrigger": true
    }
  ]
}

On this Page: