Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Start migration API

  • Updated: 2022/09/15
    • Automation 360 v.x
    • Manage
    • RPA Workspace

Start migration API

Use this API to migrate bots (TaskBots and MetaBots) created using the Enterprise Client version 11.x to Automation 360.

Request

POST https://{{ControlRoomURL}}/v3/migration/start
Header: X-Authorization <<authentication token>>
All API calls must contain an authentication token in the request header. Use the Authentication API to generate a JSON web token. See Authentication API.
Request body:
{
   "name":"Migration.migrator.22.07.06.17.59.47",
   "description":"Migrating Legacy Bot",
   "overwriteBots":true,
   "botIds":[
      13
   ],
   "userIds":[
      5
   ],
   "legacyExcelCellRow":true,
   "includeChildFolders":false,
   "folderIds":[
      
   ],
   "emailEwsSettings":true,
   "emailEwsExchangeVersion":"Exchange2010",
   "emailEwsAuthenticationType":"Basic"
   "convertToEdgeWithIeMode":true,
   "botAnalytics":true,
   "webServicesProxySettings":true,
   "excludeBotDependencies":true
}
Note: Complete the prerequisite tasks before migrating Enterprise 11 bots to Automation 360. Prerequisite tasks for migrating bots

Request parameters

Parameter Type Required Description
name String Yes The name for the migration entity.
description String No A short description for the migration.
overwriteBots Boolean No Set this parameter to true if you want to migrate already migrated bots again. The default value is false.
botIds integer Yes Bot IDs to run the migration.
userIds Integer Yes Bot Runner users' IDs where this migration will be run on.
legacyExcelCellRow Boolean No Set this parameter to true if you want to use the "Excel Cell Row" legacy behavior. If you are migrating from 11.3.0 or earlier, select this option. The default value is false.
includeChildFolders Boolean No Set this parameter to true if you want to include the child folders during the migration. The default value is false.
folderIds Integer No Folder IDs for all the bots contained in the subfolder with the folderIds.
emailEwsSettings Boolean No Set this parameter to true if you have used EWS in Enterprise 11. The default value is false.
emailEwsExchangeVersion String No This is used to specify the version of the EWS server configured in Enterprise 11. When you set emailEwsSettings to true, you can set a value to the email exchange server (emailEwsExchangeVersion). The possible values are as follows: Exchange2010, Exchange2010_SP1, Exchange2010_SP2, Exchange2007_SP1, and Exchange2013.
emailEwsAuthenticationType String No This is used to specify the authentication type set for the EWS server configured in Enterprise 11. The possible values are as follows: Basic and OAuth2.
convertToEdgeWithIeMode Boolean No Set this parameter to true if you want to migrate bots that use Internet Explorer to use Microsoft Edge with IE mode. The default value is false.
botAnalytics Boolean No Set this parameter to true if you want to tag bots and variables for analytics through Bot Insight. If you are not using Bot Insight in legacy bots, set it to false. The default value is false.
webServicesProxySettings Boolean No Set this parameter to true if you want to migrate along with the web services proxy host and port. If this value is true, precreated global values will be available to the bot for connecting with the web services proxy. The default value is false.
excludeBotDependencies Boolean No Set this to true if you want all the bot dependencies to be excluded during migration. The default value is false.