Migration API

Use the migration APIs to migrate TaskBots and MetaBots that were created in Enterprise client versions Enterprise 11 and Enterprise 10 to Automation 360. Review the prerequisites before migrating bots to Automation 360. For more details, see Prerequisite tasks for migrating bots.

All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<bearer token>>

More information: https://helloreverb.com

Contact Info: hello@helloreverb.com

Version: 2.0.0

All rights reserved

http://apache.org/licenses/LICENSE-2.0.html

Access

APIKey KeyParamName:X-Authorization KeyInQuery:false KeyInHeader:true

Methods

Models

Table of Contents

Migration

post /list
post /{migrationid}/journal/{journalid}/actionmappings/list
post /{migrationid}/results/list
post /start

Migration

Up

post /list

List the results of migration (listPost)

Use this API to list the overall migration results for each migration you run. You can send an API request with or without filter parameters. An API request without any filter parameters specified, retrieves details of all the migration. You can use the filter parameters to retrieve specific migration details. For more information, see <a href="https://docs.automationanywhere.com/bundle/enterprise-v2019/page/enterprise-cloud/topics/control-room/control-room-api/cloud-api-filter-request.html">Filtering, pagination, and sorting</a>.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body FilterRequest (required)

Body Parameter —

Return type

MigrationFilterResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 2,
    "total" : 2,
    "offset" : 0
  },
  "list" : [ {
    "updatedBy" : 32,
    "numSkipped" : 0,
    "durationMillis" : 18120,
    "updatedOn" : "2022-11-25T06:44:10.053Z",
    "migrationType" : 6,
    "duration" : "18s",
    "numFailed" : 0,
    "numTotal" : 1,
    "createdBy" : 32,
    "name" : "Migration.mig_admin.22.11.24.14.13.55",
    "startTime" : "2022-11-25T06:43:51.933Z",
    "id" : 2,
    "endTime" : "2022-11-25T06:44:10.053Z",
    "numSuccess" : 1,
    "status" : "SUCCESSFUL"
  }, {
    "updatedBy" : 32,
    "numSkipped" : 0,
    "durationMillis" : 18120,
    "updatedOn" : "2022-11-25T06:44:10.053Z",
    "migrationType" : 6,
    "duration" : "18s",
    "numFailed" : 0,
    "numTotal" : 1,
    "createdBy" : 32,
    "name" : "Migration.mig_admin.22.11.24.14.13.55",
    "startTime" : "2022-11-25T06:43:51.933Z",
    "id" : 2,
    "endTime" : "2022-11-25T06:44:10.053Z",
    "numSuccess" : 1,
    "status" : "SUCCESSFUL"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Returns model for given id MigrationFilterResponse

400

404

500

Up

post /{migrationid}/journal/{journalid}/actionmappings/list

List the action mapping result of individual bot migration. (migrationidJournalJournalidActionmappingsListPost)

Use this API to list action mapping results for bots by unique numeric identifiers for the migration ID and the journal ID, and then filter the results by selected fields. For more information about finding the journal ID, see <a href="https://docs.automationanywhere.com/bundle/enterprise-v2019/page/enterprise-cloud/topics/control-room/control-room-api/cloud-how-to-find-journalid.html">How to find a migration journalid</a>.

Path parameters

migrationid (required)

Path Parameter — ID of the Migration format: int64

journalid (required)

Path Parameter — Journal ID of the migrated bot format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body FilterRequest (required)

Body Parameter —

Return type

ActionMappingsResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 1,
    "total" : 1,
    "offset" : 0
  },
  "list" : [ {
    "reason" : "Terminal Emulator - Connect' action has been migrated. The connection type is configured as 'SSH2' since 'SSH1' is not supported in A360. No further action required. Message Code: R114",
    "actionRequiredReason" : "Referenced variables are missing in the V10/11 bot. For the migrated bot to run, update the String-UpperCase action in the migrated bot by providing missing required variables. Message code: A136",
    "isReviewRequired" : true,
    "targetAction" : "TerminalEmulator-connectV2",
    "targetNodeUid" : "ba97973a-e231-44b3-b208-1056dc2520d8",
    "reviewRequiredReasonMarkdown" : "Terminal Emulator - Connect' action has been migrated. The connection type is configured as 'SSH2' since 'SSH1' is not supported in A360. No further action required. Message Code: [R114](https://docs.automationanywhere.com/bundle/enterprise-v2019/page/enterprise-cloud/topics/migration/migration-messages.html#tpc-migration-messages__ar-R114)",
    "isActionRequired" : true,
    "targetPackageVersion" : "4.3.0-20211016-070439",
    "sourceAction" : "TE-Connect",
    "targetLineNumber" : 1,
    "actionRequiredReasonMarkdown" : "Referenced variables are missing in the V10/11 bot. For the migrated bot to run, update the String-UpperCase action in the migrated bot by providing missing required variables. Message code: [A136](https://docs.automationanywhere.com/bundle/enterprise-v2019/page/enterprise-cloud/topics/migration/migration-messages.html#tpc-migration-messages__ar-A136).",
    "targetPackageName" : "TerminalEmulator",
    "sourceLineNumber" : 1,
    "id" : 1309,
    "remarks" : "None"
  }, {
    "reason" : "Terminal Emulator - Connect' action has been migrated. The connection type is configured as 'SSH2' since 'SSH1' is not supported in A360. No further action required. Message Code: R114",
    "actionRequiredReason" : "Referenced variables are missing in the V10/11 bot. For the migrated bot to run, update the String-UpperCase action in the migrated bot by providing missing required variables. Message code: A136",
    "isReviewRequired" : true,
    "targetAction" : "TerminalEmulator-connectV2",
    "targetNodeUid" : "ba97973a-e231-44b3-b208-1056dc2520d8",
    "reviewRequiredReasonMarkdown" : "Terminal Emulator - Connect' action has been migrated. The connection type is configured as 'SSH2' since 'SSH1' is not supported in A360. No further action required. Message Code: [R114](https://docs.automationanywhere.com/bundle/enterprise-v2019/page/enterprise-cloud/topics/migration/migration-messages.html#tpc-migration-messages__ar-R114)",
    "isActionRequired" : true,
    "targetPackageVersion" : "4.3.0-20211016-070439",
    "sourceAction" : "TE-Connect",
    "targetLineNumber" : 1,
    "actionRequiredReasonMarkdown" : "Referenced variables are missing in the V10/11 bot. For the migrated bot to run, update the String-UpperCase action in the migrated bot by providing missing required variables. Message code: [A136](https://docs.automationanywhere.com/bundle/enterprise-v2019/page/enterprise-cloud/topics/migration/migration-messages.html#tpc-migration-messages__ar-A136).",
    "targetPackageName" : "TerminalEmulator",
    "sourceLineNumber" : 1,
    "id" : 1309,
    "remarks" : "None"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Returns model for given id ActionMappingsResponse

400

404

500

Up

post /{migrationid}/results/list

List the migration status of individual bot (migrationidResultsListPost)

Use this API to retrieve migration status for a specific migration ID.

Path parameters

migrationid (required)

Path Parameter — ID of the Migration format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body FilterRequest (required)

Body Parameter —

Return type

BotResultsResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 1,
    "total" : 1,
    "offset" : 0
  },
  "list" : [ {
    "sourceId" : 1333,
    "reason" : "Failure reason text here in case the bot migration failed",
    "selectedByUser" : true,
    "targetName" : "Calc",
    "targetId" : 1337,
    "targetPath" : "Automation Anywhere\\Bots\\Calc",
    "targetType" : "application/vnd.aa.taskbot",
    "userId" : 133,
    "sourceType" : "application/vnd.aa.atmx",
    "sourceName" : "Calc.atmx",
    "id" : 1,
    "sourcePath" : "Automation Anywhere\\Bots\\Calc.atmx",
    "status" : "SUCCESS"
  }, {
    "sourceId" : 1333,
    "reason" : "Failure reason text here in case the bot migration failed",
    "selectedByUser" : true,
    "targetName" : "Calc",
    "targetId" : 1337,
    "targetPath" : "Automation Anywhere\\Bots\\Calc",
    "targetType" : "application/vnd.aa.taskbot",
    "userId" : 133,
    "sourceType" : "application/vnd.aa.atmx",
    "sourceName" : "Calc.atmx",
    "id" : 1,
    "sourcePath" : "Automation Anywhere\\Bots\\Calc.atmx",
    "status" : "SUCCESS"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Returns model for given id BotResultsResponse

400

404

500

Up

post /start

Start Bot migration (startPost)

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

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body MigrationRequest (required)

Body Parameter —

Return type

MigrationResponse

Example data

Content-Type: application/json

{ }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

No Content MigrationResponse

400

404

500

Models

Methods

`ActionMapping` Up

targetLineNumber (optional)

Integer The target line number in the migrated bot.

example: 1

targetAction (optional)

String The target action in the migrated bot.

example: TerminalEmulator-connectV2

isReviewRequired (optional)

Boolean Specifies whether the action migrated requires your review.

reason (optional)

String Describes the reason for the review required.

example: Terminal Emulator - Connect' action has been migrated. The connection type is configured as 'SSH2' since 'SSH1' is not supported in A360. No further action required. Message Code: R114

remarks (optional)

String Provides more information on this migrated action.

example: None

id (optional)

Integer ID of the migration action mapping result.

example: 1309

sourceLineNumber (optional)

Integer Source line number in source bot.

example: 1

sourceAction (optional)

String Source action in source bot

example: TE-Connect

targetNodeUid (optional)

String Target node UID

example: ba97973a-e231-44b3-b208-1056dc2520d8

targetPackageName (optional)

String Target action package name

example: TerminalEmulator

targetPackageVersion (optional)

String Target action package version

example: 4.3.0-20211016-070439

isActionRequired (optional)

Boolean Specifies whether the action migrated requires your action

actionRequiredReason (optional)

String Describes what action is required

example: Referenced variables are missing in the V10/11 bot. For the migrated bot to run, update the String-UpperCase action in the migrated bot by providing missing required variables. Message code: A136

reviewRequiredReasonMarkdown (optional)

String Review required reason with support help link for the message code

example: Terminal Emulator - Connect' action has been migrated. The connection type is configured as 'SSH2' since 'SSH1' is not supported in A360. No further action required. Message Code: [R114](https://docs.automationanywhere.com/bundle/enterprise-v2019/page/enterprise-cloud/topics/migration/migration-messages.html#tpc-migration-messages__ar-R114)

actionRequiredReasonMarkdown (optional)

String Action required reason with support help link for the message code

example: Referenced variables are missing in the V10/11 bot. For the migrated bot to run, update the String-UpperCase action in the migrated bot by providing missing required variables. Message code: [A136](https://docs.automationanywhere.com/bundle/enterprise-v2019/page/enterprise-cloud/topics/migration/migration-messages.html#tpc-migration-messages__ar-A136).

`ActionMappingsResponse` Up

page (optional)

Object

list (optional)

array[ActionMapping]

`BotResultsResponse` Up

page (optional)

Object

list (optional)

array[MigrationBots]

`Error` Up

code (optional)

String Error code

message (optional)

String Error Message

details (optional)

String More details of the error message

`Filter` Up

Filter rules

operator (optional)

String Operator

Enum:

NONE

lt

le

eq

ne

ge

gt

substring

and

or

not

operands (optional)

array[Filter]

example: {operator=substring, field=id, value=32}

field (optional)

String Filtering field can be either name, lastModified, path, or folder.

example: name

value (optional)

String Filter value

example: Migration.mig_admin.22.11.24.14.13.55

`FilterRequest` Up

Filter request, which includes filtering, sorting and pagination rules

filter (optional)

Filter

sort (optional)

array[Sort] Sort directions

page (optional)

PageRequest

`MigratedBotDetails` Up

targetBotId (optional)

Integer

name (optional)

String

status (optional)

String

reason (optional)

String

actions (optional)

array[ActionMapping]

`MigrationBots` Up

sourceId (optional)

Integer Unique ID of the migration

example: 1333

sourceName (optional)

String Name of the file migrated

example: Calc.atmx

sourcePath (optional)

String Migrated file path

example: Automation Anywhere\Bots\Calc.atmx

sourceType (optional)

String Type of file migrated

example: application/vnd.aa.atmx

targetId (optional)

Integer Unique target ID of the migrated bot

example: 1337

status (optional)

String Status of migration. Possible values are success, failed, skipped.

example: SUCCESS

reason (optional)

String Reason why the bot failed

example: Failure reason text here in case the bot migration failed

selectedByUser (optional)

Boolean

userId (optional)

Integer Unique ID of the user

example: 133

id (optional)

Integer Migration ID

example: 1

targetName (optional)

String Migrated bot target name

example: Calc

targetPath (optional)

String Target path

example: Automation Anywhere\Bots\Calc

targetType (optional)

String Migrated bot target type

example: application/vnd.aa.taskbot

`MigrationFilterResponse` Up

page (optional)

Object

list (optional)

array[MigrationStatistics]

`MigrationRequest` Up

name (optional)

String The name for the migration entity.

example: Migration.mig_admin.22.11.24.14.13.55

description (optional)

String A short description for the migration.

example: Migrate Finance 10x Bot to A360

overwriteBots (optional)

Boolean Set this parameter to true if you want to migrate already migrated bots again. The default value is false.

botIds (optional)

array[Integer] Bot IDs to run the migration.

userIds (optional)

array[Integer] Bot Runner users' IDs where this migration will be run on.

folderIds (optional)

array[Integer] Folder IDs for all the bots contained in the subfolder with the folderIds.

includeChildFolders (optional)

Boolean Set this parameter to true if you want to include the child folders during the migration. The default value is false.

legacyExcelCellRow (optional)

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

emailEwsSettings (optional)

Boolean Set this parameter to true if you have used EWS in Enterprise 11. The default value is false.

emailEwsExchangeVersion (optional)

String 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 Exchange2010, Exchange2010_SP1, Exchange2010_SP2, Exchange2007_SP1, and Exchange2013.

example: Exchange2010

emailEwsAuthenticationType (optional)

String This is used to specify the authentication type set for the EWS server configured in Enterprise 11. The possible values are Basic and OAuth2.

example: Basic

excludeBotDependencies (optional)

Boolean Set this to true if you want all the bot dependencies to be excluded during migration. The default value is false.

convertToEdgeWithIeMode (optional)

Boolean 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 (optional)

Boolean 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 (optional)

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

convertNewLineToCrlf (optional)

Boolean Set this parameter to true if you want to convert \n characters in bot to \r\n characters, which will add new line in bots using Log To file action. The defualt value is false.

emailSmtpSettings (optional)

Boolean Set this parameter to true if you have used SMTP in Enterprise 11. The default value is false.

emailSmtpSecureConnection (optional)

Boolean Set this parameter to true if you have used SMTP secure connection in Enterprise 11. The default value is false.

emailSmtpRequiresAuthentication (optional)

Boolean Set this parameter to true if you have used SMTP credentials in Enterprise 11. The default value is false.

`MigrationResponse` Up

`MigrationStatistics` Up

id (optional)

Integer Migration ID

example: 2

name (optional)

String Name specified for the migration

example: Migration.mig_admin.22.11.24.14.13.55

startTime (optional)

String

example: 2022-11-25T06:43:51.933Z

endTime (optional)

String

example: 2022-11-25T06:44:10.053Z

createdBy (optional)

Integer User ID who created the migration

example: 32

duration (optional)

String Total duration the migration ran

example: 18s

numSuccess (optional)

Integer Number of successful migrations

example: 1

numFailed (optional)

Integer Number of failed migrations

example: 0

numSkipped (optional)

Integer Number of skipped migrations

example: 0

numTotal (optional)

Integer Total number of migrations

example: 1

status (optional)

String Status of the migration. Possible values are successful, skipped, failed.

example: SUCCESSFUL

updatedOn (optional)

String

example: 2022-11-25T06:44:10.053Z

updatedBy (optional)

Integer

example: 32

durationMillis (optional)

Integer Duration the migration ran in milliseconds

example: 18120

migrationType (optional)

Integer Type of migration performed. Possible values are BOT, ROLE, or AUDIT_DATA.

`PageRequest` Up

Pagination rules

offset (optional)

Integer Page starting index

length (optional)

Integer Page length

example: 100

`Sort` Up

Sorting rules

field (optional)

String Field name to sort by

example: name

direction (optional)

String Sorting direction

Enum:

asc

desc

`responses` Up