The Migration APIs allow you to,

1. Save / update connection configuration to the 10.x Control Room database
2. Save / update connection configuration to the 2.x Bot Insight database, if available
3. Specify option to migrate data based on Roles, Users or Bots
4. Fetch list of data based on option specified for migration that is, Roles, Users, or Bots
5. View the migration progress summary
6. View migration statistics of number of entities that succeeded / failed per migration
7. Fetch list of new and updated bots from 10.x Control Room post migration
8. Migrate files in bulk from the 10.x Control Room My docs folder post migration

Alternately, you can use the Migration wizard given in Administration > Migration module to migrate the data from the Control Room user interface. Refer Migration Overview for details.

API End Point

Use the following end points to access the API:

1. For migration process use <Control Room URL>/v2/migration
2. For migrating files from the My Docs folder of source 10.x Control Room after the migration process has completed use <Control Room URL>/v1/migration

For example,

https://crdevenv.com:81/v2/migration

Migration Process APIs

The Migration APIs allow you to migrate 10.x Control Room data to 11.x Control Room using the end point mentioned earlier.

Before accessing the Migration API's you must first use the authentication API and pass it as a token to use a particular Migration API.

1. Use the POST method to generate a token using the end point http(s)://<hostname:port>/v1/authentication. For this provide the Control Room instance as Server Name /Hostname /IP and the Port number.

   For example,https://crdevenv.com:81/v1/authentication

2. Provide the following request payload in Headers

   "X-Authorization" : "Authorization token"

   "Content-Type" : "application/json"

3. Provide the following request payload in Body:

   {

   "username": "<Username>",

   "password": "<Password>"

   }

   For example,

   {

   "usename": "Ellie.Brown",

   "password": "12345678"

   }

1. Connect to source Control Room database

This API allows you to save and update the connection configuration to the source 10.x Control Room database.

1. Provide the "X-Authorization" and "Content Type" parameters in Headers.
2. Provide credential parameters in Body
3. Use the POST method to connect to the 10.x Control Room database using the end point http(s)://<hostname:port>/v2/migration/connection

   For example,https://crdevenv.com:81/v2/migration/connection

4. Provide the following request parameters in Body:

   {

   "host": "string", "port": 0, "databaseName": "string", "username": "string", "password": "string", "integratedSecurity": true, "encrypt": true, "privateKey": "string", "repoPath": "string"

   }

   For example,

   {

   "host": "PRODUCTLT",

   "port": 1433,

   "databaseName": "CR104MIG",

   "username": "Ellie.Brown",

   "password": "12345678",

   "integratedSecurity": true,

   "encrypt": true,

   "privateKey": "ABC123",

   "repoPath": "D:\\Data\Automation Anywhere Server Files"

   }

5. Click Send.

Parameter Description

2. Get stored connection details

This API allows you to fetch the stored connection details of source 10.x Control Room database from where the data can be migrated.

1. Provide the "X-Authorization" and "Content Type" parameters in Headers.
2. Provide credential parameters in Body
3. Use the GET method to fetch the connection configuration of 10.x Control Room database using the end point http(s)://<hostname:port>/v2/migration/connection

   For example, https://crdevenv.com:81/v2/migration/connection

4. Click Send
5. You can view the result in Body data:

   {

   "host": "productlt",

   "port": 1433,

   "databaseName": "CR104MIG",

   "username": "",

   "password": "",

   "integratedSecurity": true,

   "encrypt": false,

   "privateKey": "",

   "repoPath": "D:\\DATA\AUTOMATION ANYWHERE SERVER FILES"

   }

Parameter Description

3. Connect to 2.x Bot Insight database, if available

This API allows you to connect to the source 2.x Bot Insight database if available, to migrate analytics data.

1. Provide the "X-Authorization" and "Content Type" parameters in Headers.
2. Provide credential parameters in Body.
3. Use the POST method to connect to the Bot Insight database using the end point http(s)://<hostname:port>/v2/migration/connection /botinsight

   For example, https://crdevenv.com:81/v2/migration/connection/botinsight

4. Provide following request parameters in Body:

   {

   "host": "string",

   "port": 0,

   "databaseName": "string",

   "username": "string",

   "password": "string",

   "integratedSecurity": true,

   "encrypt": true,

   "serverUrl": "string"

   }

   For example,

   {

   "host": "Productlt",

   "port": 8091,

   "databaseName": "BotInsight",

   "username": "Ellie.Brown",

   "password": "12345678",

   "integratedSecurity": true,

   "encrypt": true,

   "serverUrl": "https://productlt.example.com:82/analytics"

   }

5. Click Send
6. The connection parameters are successfully saved when the response status is 200 Successful operation .

Parameter Description

4. Get stored connection details

This API allows you to fetch the stored connection details of source 2.x Bot Insight database from where the data can be migrated.

1. Provide the "X-Authorization" and "Content Type" parameters in Headers.
2. Provide credential parameters in Body
3. Use the GET method to fetch the connection configuration of 10.x Control Room database using the end point http(s)://<hostname:port>/v2/migration/connection/botinsight

   For example,https://crdevenv.com:81/v2/migration/connection/botinsight

4. Click Send
5. The connection parameters are successfully saved when the response status is 200 Migration config .
6. You can view the result in Body data:

   {

   "host": "Productlt",

   "port": 8091,

   "databaseName": "BotInsight",

   "username": "Ellie.Brown",

   "password": "12345678",

   "integratedSecurity": true,

   "encrypt": true,

   "serverUrl": "https://productlt.example.com:82/analytics"

   }

Parameter description

5. List of entities of TYPE available for migration in source database

This API returns list of entities available for migration in source database by TYPE parameter. Using the either of the options - Role, User, Bot, or Schedule, you can migrate all data that is associated with the parameter chosen.

1. Provide the "X-Authorization" parameters in Headers.
2. Use the GET method to connect to the Control Room database using the end point http(s)://<hostname:port>/v2/migration/connection /entities followed by TYPE parameter that could include any one of the option - Roles, Users, Bots, or Schedules

   For example,https://crdevenv.com:81/v2/migration/connection/entities?Type=ROLE

3. Click Send
4. The data is returned when the response status is 200
5. The list of entities based on TYPE parameter are displayed in Body.

   {

   "entities":

   [

   { "id": "0", "type": "ROLE", "sourceId": "1", "targetId": "0", "name": "Admin", "status": "SUCCESS", "reason": "" },

   { "id": "0", "type": "ROLE", "sourceId": "2", "targetId": "0", "name": "Basic", "status": "SUCCESS", "reason": "" },

   { "id": "0", "type": "ROLE", "sourceId": "3", "targetId": "0", "name": "IQBotValidator", "status": "SUCCESS", "reason": "" },

   { "id": "0", "type": "ROLE", "sourceId": "4", "targetId": "0", "name": "AnalyticsExperts", "status": "SUCCESS", "reason": "" },

   { "id": "0", "type": "ROLE", "sourceId": "5", "targetId": "0", "name": "AnalyticsConsumers", "status": "SUCCESS", "reason": "" },

   { "id": "0", "type": "ROLE", "sourceId": "6", "targetId": "0", "name": "BotAgentUser", "status": "SUCCESS", "reason": "" },

   { "id": "0", "type": "ROLE", "sourceId": "7", "targetId": "0", "name": "BotFarmAdmin", "status": "SUCCESS", "reason": "" },

   { "id": "0", "type": "ROLE", "sourceId": "8", "targetId": "0", "name": "IQBotServices", "status": "SUCCESS", "reason": "" },

   { "id": "0", "type": "ROLE", "sourceId": "9", "targetId": "0", "name": "Bot Creator 10x", "status": "SUCCESS", "reason": "" },

   { "id": "0", "type": "ROLE", "sourceId": "10", "targetId": "0", "name": "Bot Runner 10x", "status": "SUCCESS", "reason": "" },

   { "id": "0", "type": "ROLE", "sourceId": "11", "targetId": "0", "name": "Bot Scheduler 10x", "status": "SUCCESS", "reason": "" }

   ]

   }

Parameter description

6. Prepare migration data based on User input

This API allows you to migrate entities with associated data based on the sub-section of the entity type specified for migration.

1. Provide the "X-Authorization" and "Content Type" parameters in Headers.
2. Use the POST method to migrate the data using the endpoint http(s)://<hostname:port>/v2/migration/prepare

   For example,https://crdevenv.com:81/v2/migration/prepare

3. Provide following request payload in Body:

   {

   "selected":

   [

   { "type": "<enitity type>",

   "sourceId": "string" }

   ],

   "excludes": [ "<entity type>"

   ]

   }

   For example,

   { "selected": [ { "type": "ROLE", "sourceId": "12" } ], "excludes": [ "BOT" ] }

4. Click Send
5. The data is listed successfully for migration when the response status is 200
6. The result is displayed in the Body

   { "selected":

   [

   { "type": "ROLE", "sourceId": "12" } ],

   "excludes": [ "BOT" ]

   }

Parameter description

7. Start Migration

This API allows you to launch the migration process.

1. Provide the "X-Authorization" parameters in Headers.
2. Use the POST method to migrate the data using the endpoint http(s)://<hostname:port>/v2/migration/start/async

   For example, https://crdevenv.com:81/v2/migration/start/async

3. Click Send
4. The data migration starts successfully when the response status is 200 Successful operation
5. The result is displayed in the Body data

   {

   "id": 1,

   "name": "2018.07.17.16.13.48.ellie.brown",

   "createdBy": 1,

   "migrationType": "ROLE_EXCLUDE_BOT_SCHEDULE"

   }

Parameter description

8. Migration object by id

This API lists the migration object details based on the ID that is generated using the Start Migration API.

1. Provide the "X-Authorization" parameters in Headers.
2. Use the GET method to fetch object details by id using the endpoint http(s)://<hostname:port>/v2/migration/<id>

   For example, https://crdevenv.com:81/v2/migration/9

3. Click Send.
4. The object details are listed successfully when the response status is 200
5. The details are shown in the Body data:

   {

   "id": "9",

   "name": "2018.07.17.16.13.48.ellie.brown",

   "startTime": "2018-07-17T10:43:48.127Z",

   "endTime": "2018-07-17T10:43:49.833Z",

   "createdBy": "1",

   "migrationType": "ROLE_EXCLUDE_BOT_SCHEDULE",

   "entities": []

   }

Parameter description

9. Migration Progress

This API allows you to view the process of migration that is in progress.

1. Provide the "X-Authorization" and "Content Type" parameters in Headers.
2. Provide credential parameters in Body
3. Use the GET method to fetch object details by id using the endpoint http(s)://<hostname:port>/v2/migration/pogress

   For example, https://crdevenv.com:81/v2/migration/progress

4. Click Send.
5. The object details are listed successfully when the response status is 200
6. The details are shown in the Body data:

   {

   "migration":

   { "id": "10", "name": "2018.07.17.16.55.59.ellie.brown", "startTime": "2018-07-17T11:25:59.800Z", "endTime": "2018-07-17T11:26:16.002Z", "createdBy": "1", "migrationType": "BOT_EXCLUDE_MetaBot", "entities": [] },

   "current": "SCHEDULE",

   "progress":

   {

   "BOT": { "total": "10", "successful": "7", "failed": "0", "skipped": "3" },

   "SCHEDULE": { "total": "8", "successful": "8", "failed": "0", "skipped": "0" }

   }

   }

Parameter description

10. Migration statistics - number of entities that succeeded / failed per migration

This API allows you to view the number of successful or failed entities per migration.

1. Provide the "X-Authorization" parameters in Headers.
2. Use the GET method to fetch object details by id using the endpoint http(s)://<hostname:port>/v2/migration/statistics

   For example, https://crdevenv.com:81/v2/migration/statistics

3. Click Send.
4. The object details are listed successfully when the response status is 200
5. The details are shown in the Body data:

   {

   "items": [

   { "id": "1", "name": "2018.07.13.11.14.59.ellie.brown", "startTime": "2018-07-13T05:44:59.787Z", "endTime": "2018-07-13T06:56:25.537Z", "createdBy": "1", "duration": "4285s", "numSuccess": 0, "numFailed": 0, "numSkipped": 0 },

   { "id": "2", "name": "2018.07.13.12.28.08.ellie.brown", "startTime": "2018-07-13T06:58:09.283Z", "endTime": "2018-07-13T06:58:12.910Z", "createdBy": "1", "duration": "3s", "numSuccess": 1, "numFailed": 1, "numSkipped": 0 },

   { "id": "3", "name": "2018.07.13.12.40.34.ellie.brown", "startTime": "2018-07-13T07:10:34.470Z", "endTime": "2018-07-13T07:10:40.060Z", "createdBy": "1", "duration": "5s", "numSuccess": 10, "numFailed": 0, "numSkipped": 0 },

   { "id": "4", "name": "2018.07.13.12.42.19.ellie.brown", "startTime": "2018-07-13T07:12:20.007Z", "endTime": "2018-07-13T07:12:23.107Z", "createdBy": "1", "duration": "3s", "numSuccess": 0, "numFailed": 0, "numSkipped": 6 },

   { "id": "5", "name": "2018.07.13.13.39.53.ellie.brown", "startTime": "2018-07-13T08:09:53.113Z", "endTime": "2018-07-13T08:10:02.673Z", "createdBy": "1", "duration": "9s", "numSuccess": 4, "numFailed": 0, "numSkipped": 0 }

   ]

   }

Parameter description

Post Migration process APIs

Use the Migration APIs after the process has completed to

1. Import files from the My Docs folder of 10.x Control Room
2. Fetch the list of new or modified bots from 10.x Control Room since last migration run
   Note: Before accessing the APIs you must first use the authentication API and pass it as a token to use a particular Migration API.
3. Use the POST method to generate a token using the end point http(s)://<hostname:port>/v1/authentication. For this provide the Control Room instance as Server Name /Hostname /IP and the Port number.

   For example,https://crdevenv.com:81/v1/authentication

4. Provide the following request payload in Headers

   "X-Authorization" : "Authorization token"

   "Content-Type" : "application/json"

5. Provide the following request payload in Body:

   {

   "username": "<Username>",

   "password": "<Password>"

   }

For example,

{

"usename": "Ellie.Brown",

"password": "12345678"

}

A. Import files from My Docs folder

Use certain set of APIs to migrate files from the My Docs folder of the 10.x Control Room. These APIs allow you to import large number of files that could either be used in bots as dependencies or though stand alone are useful for automation.

1. Fetch list of root folders from 10.x Control Room

This API allows you to fetch the list of folders available in the 10.x Control Room Repository. This will help you understand the folder structure that was available in the source Control Room.

1. Provide the "X-Authorization" parameters in Headers.
2. Use the GET method to fetch object details by id using the endpoint http(s)://<hostname:port>/v1/migration/legacyrepository/rootDirectories followed by excludeMetaBot) parameter

   For example, https://crdevenv.com:81/v1/migration/legacyrepository/rootDirectories?excludeMetaBot=true

3. Click Send
4. The object details are listed successfully when the response status is 200
5. The details are shown in the Body data:

   [

   { "name": "My Docs", "path": "Automation Anywhere\\My Docs" },

   { "name": "My Exes", "path": "Automation Anywhere\\My Exes" },

   { "name": "My Reports", "path": "Automation Anywhere\\My Reports" },

   { "name": "My Scripts", "path": "Automation Anywhere\\My Scripts" },

   { "name": "My Tasks", "path": "Automation Anywhere\\My Tasks" },

   { "name": "My Workflow", "path": "Automation Anywhere\\My Workflow" }

   ]

Parameter description

2. Fetch list of sub-folders of a root-folder from 10.x Control Room

This API allows you to fetch the list of sub-folders for a given root-folder available in the 10.x Control Room Repository. This will help you understand the folder structure of the source Control Room.

1. Provide the "X-Authorization" parameters in Headers.
2. Use the GET method to fetch object details by id using the endpoint http(s)://<hostname:port>/v1/migration/legacyrepository/childDirectories followed by the path parameter

   For example, https://crdevenv.com:81/v1/migration/legacyrepository/childDirectories?path=Automation Anywhere\My Docs

3. Click Send.
4. The object details are listed successfully when the response status is 200
5. The details are shown in the Body data:

   {

   "folders":

   [

   { "name": "Log-Files", "path": "Automation Anywhere\\My Docs\\Log-Files" }

   ]

   }

Parameter Description

3. Fetch list of files in given folder

This API allows you to fetch the list of files available in a given folder in the source Control Room repository.

1. Provide the "X-Authorization" parameters in Headers.
2. Use the GET method to fetch object details by id using the endpoint http(s)://<hostname:port>/v1/migration/legacyrepository/childFiles followed by the path) and excludeMetaBot) parameters

   For example, https://crdevenv.com:81/v1/migration/legacyrepository/childFiles?path=Automation Anywhere\My Docs\Log-Files&excludeMetaBot=false

3. Click Send
4. The object details are listed successfully when the response status is 200
5. The details are shown in the Body data:

   {

   "files":

   [

   { "id": "280", "name": "ActiveMQServer-2018-Jul-17-2.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\ActiveMQServer-2018-Jul-17-2.log.zip" },

   { "id": "281", "name": "IgniteServer-2018-Jul-17-4.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\IgniteServer-2018-Jul-17-4.log.zip" },

   { "id": "283", "name": "WebCR_Ignite-2018-Jul-17-4.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_Ignite-2018-Jul-17-4.log.zip" },

   { "id": "284", "name": "WebCR_License-2018-Jul-17-4.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_License-2018-Jul-17-4.log.zip" },

   { "id": "292", "name": "WebCR_Migration-2018-Jul-17-4.log", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_Migration-2018-Jul-17-4.log" },

   { "id": "285", "name": "WebCR_Migration-2018-Jul-17-4.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_Migration-2018-Jul-17-4.log.zip" },

   { "id": "293", "name": "WebCR_Migration-2018-Jul-17-4.txt", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_Migration-2018-Jul-17-4.txt" }

   ]

   }

Parameter Description

4. Search for a folder by name in Control Room 10.x

This API allows you to search for a folder by given name from the source Control Room My Docs repository.

1. Provide the "X-Authorization" parameters in Headers.
2. Use the GET method to fetch object details by id using the endpoint http(s)://<hostname:port>/v1/migration/legacyrepository/folders followed by the taskName parameter

   For example, https://crdevenv.com:81/v1/migration/legacyrepository/folders?taskName=Import-Table

3. Click Send
4. The object details are listed successfully when the response status is 200
5. The details are shown in the Body data:

   {

   "paths":

   [ "Automation Anywhere\\My Docs\\Import-Table" ]

   }

Parameter description

5. Fetch list of files for a given folder in Control Room 10.x

This API allows you to fetch a list of files from a given folder from the source Control Room My Docs repository.

1. Provide the "X-Authorization" parameters in Headers.
2. Use the POST method to fetch list of files for a given folder using the endpoint http(s)://<hostname:port>/v1/legacyrepository/files

   For example, https://crdevenv.com:81/v1/legacyrepository/files

3. Provide the list of folder paths as request payload in Body

   [

   "string"

   ]

   For example, the following lists the files available

   [

   "Automation Anywhere\\My Docs\\Import-Table"

   ]

4. Click Send
5. The object details are listed successfully when the response status is 200
6. The Response details are shown in the Body data:

   {

   "files":

   [

   { "id": 1281, "type": "BOT", "sourceId": "1281", "targetId": 0, "name": "Automation Anywhere\\My Docs\\Import-Table\\Import-Table.txt", "status": "SUCCESS", "reason": "" },

   { "id": 293, "type": "BOT", "sourceId": "293", "targetId": 0, "name": "Automation Anywhere\\My Docs\\Import-Table\\WebCR_Migration-2018-Jul-17-4.txt", "status": "SUCCESS", "reason": "" }

   ]

   }

Parameter Description

B. Migrate new or modified bots from 10.x since the last migration in 11.x

This API allows you to fetch list of bots that are new or modified in source Control Room version 10.x after data has already been migrated to destination Control Room version 11.x . Essentially, this API allows you the liberty to continue using your 10.x environment whilst the 11.x environment is ready to go into production.

1. Provide the "X-Authorization" parameters in Headers.
2. Use the POST method to fetch object details by id using the endpoint http(s)://<hostname:port>/v1/legacyrepository/changedfiles

   For example, https://crdevenv.com:81/v1/legacyrepository/changedfiles

3. Provide the list of folder paths as request payload in Body

   {

   "changeSince": "<last migration date and time>"

   }

   For example, the following lists the bot names that were update post migration

   {

   "changeSince":"2018-06-25T12:05:00+05:30"

   }

   Tip: Do not specify the changeSince parameter to consider the delta for last migration date and time.
4. Click Send.
5. The object details are listed successfully when the response status is 200
6. The Response details are shown in the Body data:

   {

   "changedfiles":

   [

   { "type": "BOT", "sourceId": "6", "name": "Automation Anywhere\\My Tasks\\Sample Tasks\\Import-Table.atmx" },

   { "type": "BOT", "sourceId": "7", "name": "Automation Anywhere\\My Tasks\\Sample Tasks\\List-Variable.atmx" }

   ]

   }

Parameter description

API Response Codes

Audit Logs

The Audit Log displays individual entry for each entity that is migrated.

When the migration process is initiated, a Migration started entry is logged in Audit log. Similarly when the migration process is completed, a Migration finished entry is logged. Between these two entries, migration entries are logged for each entity that is migrated such as Create, Update, or Upload operation.