10x Migration API

Use the migration APIs to copy roles, users, credentials, bots, and schedules that were created in Enterprise version 10 to Automation 360. With these APIs, you can connect to the Enterprise 10 Control Room database, validate the master key and the repository path, and then start copying the Enterprise 10 data to Automation 360.

You must have an admin role or the Manage Migration permission to validate connection parameters, connect to the Enterprise 10 database, and start 10.x migration process. If you want to retrieve a list of roles, users, credentials, and schedules, you need an admin role or the View Migration permission.

Execute the following three APIs in order they are listed below. You can retrieve roles, users, credentials, bots, or schedules after you executed the mandatory APIs.

After completing the migration from 10x you can review the prerequisites needed for Bot migration. 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

Class10xMigration

Up

post /connection

Connect to 10x database (connectionPost)

Use this API to connect to the Enterprise 10 Control Room database from which you can copy the data to Automation 360. You must have an admin role or a custom role with Manage Migration permission to validate connection parameters and connect to the Enterprise 10 database.<br> This API has similar request payload as v2/migration/masterKey, however, privateKey and repoPath parameters are ignored as they are applicable to v2/migration/masterKey.

Consumes

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

application/json

Request body

body object (required)

Body Parameter —

Responses

204

Connection to the database is successful

400

401

403

500

Up

post /masterkey

Validate 10x master key and repository path (masterkeyPost)

Use this API to validate 10x Credential Vault master key and repository path containing the 10x files to be migrated.<br> This API has similar request payload as v2/migration/connection, however, only privateKey and repoPath parameters are required. All other parameters are ignored. You must have an admin role or a custom role with Manage Migration permission to validate the master key and the repository path.

Consumes

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

application/json

Request body

body object (required)

Body Parameter —

Responses

200

Master key and repository path validation is successful

400

401

403

500

Up

post /{migrationId}/bots/list

List migrated bots (migrationIdBotsListPost)

Use this API to retrieve bots that are migrated from 10x database.

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

MigratedEntitiesResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 9,
    "total" : 9,
    "offset" : 0
  },
  "list" : [ {
    "sourceId" : 2,
    "reason" : "Failure reason text here in case the entity copy operation was failed",
    "targetId" : 24,
    "name" : "Name of the copied entity",
    "targetPath" : "Automation Anywhere\\Bots",
    "id" : 2,
    "type" : "ROLE/ USER/ CREDENTIAL/ BOT/ SCHEDULE",
    "status" : "SUCCESS"
  }, {
    "sourceId" : 2,
    "reason" : "Failure reason text here in case the entity copy operation was failed",
    "targetId" : 24,
    "name" : "Name of the copied entity",
    "targetPath" : "Automation Anywhere\\Bots",
    "id" : 2,
    "type" : "ROLE/ USER/ CREDENTIAL/ BOT/ SCHEDULE",
    "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

Returned migrated bots successfully MigratedEntitiesResponse

401

403

500

Up

post /{migrationId}/credentials/list

List migrated credentials (migrationIdCredentialsListPost)

Use this API to retrieve credentials that are migrated from 10x database.

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

MigratedEntitiesResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 9,
    "total" : 9,
    "offset" : 0
  },
  "list" : [ {
    "sourceId" : 2,
    "reason" : "Failure reason text here in case the entity copy operation was failed",
    "targetId" : 24,
    "name" : "Name of the copied entity",
    "targetPath" : "Automation Anywhere\\Bots",
    "id" : 2,
    "type" : "ROLE/ USER/ CREDENTIAL/ BOT/ SCHEDULE",
    "status" : "SUCCESS"
  }, {
    "sourceId" : 2,
    "reason" : "Failure reason text here in case the entity copy operation was failed",
    "targetId" : 24,
    "name" : "Name of the copied entity",
    "targetPath" : "Automation Anywhere\\Bots",
    "id" : 2,
    "type" : "ROLE/ USER/ CREDENTIAL/ BOT/ SCHEDULE",
    "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

Returned migrated credentials successfully MigratedEntitiesResponse

401

403

500

Up

post /{migrationId}/roles/list

List migrated roles (migrationIdRolesListPost)

Use this API to retrieve roles that are migrated from 10x database. You can send an API request with or without filter parameters. An API request without any filter parameters specified, retrieves details of all the migrated roles. You can use the filter parameters to retrieve specific role 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>. You must have an admin role or a custom role with View Migration permission to retrieve migrated list.

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

MigratedEntitiesResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 9,
    "total" : 9,
    "offset" : 0
  },
  "list" : [ {
    "sourceId" : 2,
    "reason" : "Failure reason text here in case the entity copy operation was failed",
    "targetId" : 24,
    "name" : "Name of the copied entity",
    "targetPath" : "Automation Anywhere\\Bots",
    "id" : 2,
    "type" : "ROLE/ USER/ CREDENTIAL/ BOT/ SCHEDULE",
    "status" : "SUCCESS"
  }, {
    "sourceId" : 2,
    "reason" : "Failure reason text here in case the entity copy operation was failed",
    "targetId" : 24,
    "name" : "Name of the copied entity",
    "targetPath" : "Automation Anywhere\\Bots",
    "id" : 2,
    "type" : "ROLE/ USER/ CREDENTIAL/ BOT/ SCHEDULE",
    "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

Migrated roles are returned successfully MigratedEntitiesResponse

401

403

500

Up

post /{migrationId}/schedules/list

List migrated schedules (migrationIdSchedulesListPost)

Use this API to retrieve schedules that are migrated from 10x database.

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

MigratedEntitiesResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 9,
    "total" : 9,
    "offset" : 0
  },
  "list" : [ {
    "sourceId" : 2,
    "reason" : "Failure reason text here in case the entity copy operation was failed",
    "targetId" : 24,
    "name" : "Name of the copied entity",
    "targetPath" : "Automation Anywhere\\Bots",
    "id" : 2,
    "type" : "ROLE/ USER/ CREDENTIAL/ BOT/ SCHEDULE",
    "status" : "SUCCESS"
  }, {
    "sourceId" : 2,
    "reason" : "Failure reason text here in case the entity copy operation was failed",
    "targetId" : 24,
    "name" : "Name of the copied entity",
    "targetPath" : "Automation Anywhere\\Bots",
    "id" : 2,
    "type" : "ROLE/ USER/ CREDENTIAL/ BOT/ SCHEDULE",
    "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

Returned migrated schedules successfully MigratedEntitiesResponse

401

403

500

Up

post /{migrationId}/users/list

List migrated users (migrationIdUsersListPost)

Use this API to retrieve users that are migrated from 10x database.

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

MigratedEntitiesResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 9,
    "total" : 9,
    "offset" : 0
  },
  "list" : [ {
    "sourceId" : 2,
    "reason" : "Failure reason text here in case the entity copy operation was failed",
    "targetId" : 24,
    "name" : "Name of the copied entity",
    "targetPath" : "Automation Anywhere\\Bots",
    "id" : 2,
    "type" : "ROLE/ USER/ CREDENTIAL/ BOT/ SCHEDULE",
    "status" : "SUCCESS"
  }, {
    "sourceId" : 2,
    "reason" : "Failure reason text here in case the entity copy operation was failed",
    "targetId" : 24,
    "name" : "Name of the copied entity",
    "targetPath" : "Automation Anywhere\\Bots",
    "id" : 2,
    "type" : "ROLE/ USER/ CREDENTIAL/ BOT/ SCHEDULE",
    "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

Returned migrated users successfully MigratedEntitiesResponse

401

403

500

Up

post /start

Start 10x data migration process (startPost)

Use this API to start the Enterprise 10 data migration.

Consumes

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

application/json

Request body

body DataMigrationRequest (required)

Body Parameter —

Return type

DataMigrationResponse

Example data

Content-Type: application/json

{
  "createdBy" : 10,
  "entities" : "",
  "name" : "Name of the copied entity",
  "id" : 2,
  "migrationType" : "ROLE / BOT"
}

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

Migration successful DataMigrationResponse

401

403

500

Models

Methods

Table of Contents

DataMigrationRequest
DataMigrationResponse
Error
Filter
FilterRequest
MigratedEntitiesResponse
MigrationEntity
PageRequest
PageResponse
Sort
responses

`DataMigrationRequest` Up

name

String Name of the Migration

example: Migration-10x-001

description (optional)

String Description about the Migration

example: 10x bot migration to A360

`DataMigrationResponse` Up

id (optional)

Integer The migration ID. This is used for internal purpose only.

example: 2

name (optional)

String Name of the migrated entity

example: Name of the copied entity

createdBy (optional)

Integer ID of the user who has initiated this migration.

example: 10

migrationType (optional)

String Indicates the data migration type Role or Bot.

example: ROLE / BOT

entities (optional)

String List of migration entities.

`Error` Up

code (optional)

String Error code

message (optional)

String Error Message

details (optional)

String More details of the error message

correctiveAction (optional)

String Corrective action to be taken to get rid of this error.

`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=status, value=SUCCESS}

field (optional)

String Filter field

example: name

value (optional)

String Filter value

example: Admin

`FilterRequest` Up

Filter request, which includes filtering, sorting and pagination rules

filter (optional)

Filter

sort (optional)

array[Sort] Sort directions

page (optional)

PageRequest

`MigratedEntitiesResponse` Up

page (optional)

PageResponse

list (optional)

array[MigrationEntity]

`MigrationEntity` Up

id (optional)

Integer Unique ID of the roles, users, credentials, bots, and schedules that are migrated. This ID is used for UI purposes only.

example: 2

name (optional)

String Name of the migrated entity

example: Name of the copied entity

status (optional)

String Status of the migrated entity. Valid values are Success, Skipped, or Failed.

example: SUCCESS

reason (optional)

String Reason if this entity migration has failed.

example: Failure reason text here in case the entity copy operation was failed

type (optional)

String The migration type. Valid values are ROLE, USER, CREDENTIAL, BOT, SCHEDULE.

example: ROLE/ USER/ CREDENTIAL/ BOT/ SCHEDULE

sourceId (optional)

Integer The source (database) entity ID.

example: 2

targetId (optional)

Integer The target migrated entity ID.

example: 24

targetPath (optional)

String The migrated bot file location. It is only applicable for the bot migration.

example: Automation Anywhere\Bots

`PageRequest` Up

Pagination rules

offset (optional)

Integer Page starting index

length (optional)

Integer Page length

example: 100

`PageResponse` Up

Pagingation response

offset (optional)

Integer Page starting index

total (optional)

Integer Total number of items

example: 9

totalFilter (optional)

Integer Total number of items matching filter

example: 9

`Sort` Up

Sorting rules

field (optional)

String Field name to sort by

example: name

direction (optional)

String Sorting direction

Enum:

asc

desc

`responses` Up