Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Start migration API

  • Updated: 2/05/2021
    • 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.

Prerequisites

Note: You can view the Control Room APIs in the Community Edition, but API functionality is limited. You need a licensed Automation 360 Edition to access the full functionality of the APIs.

Complete the prerequisites before migrating Enterprise 11 bots to Automation 360. Prerequisite tasks for migrating bots

Request parameters:

Parameter Required Type Description
name Yes String The name for the migration entity.
description No String A short description for the migration.
botIds Yes integer Bot IDs to run the migration.
userIds Yes Integer Bot Runner users IDs where this migration would be run on.
overwriteBots No Integer Set this parameter to true if you want to migrate the already migrated bots again. The default value is false.

Procedure

  1. Use the Authentication API to generate a JSON Web Token. See Authentication API.
  2. Use the POST method and endpoint URL: <your_control_room_url>/v3/migration/start.

    This request migrates a single bot with the botIds of 74, and the userIds of 18.

    Request body:

    {
      "name": "Docs Test Migration",
      "description": "docs test",
      "overwriteBots": true,
      "botIds": [
        74
      ],
      "userIds": [
        18
      ]
    }
  3. Send the request.
    Response body:
    { }

    The successful response includes a 200 success response and an empty body.

    You can also migrate all the bots from a sub-folder.
    Migrate all bots in a sub-folder API
    Migrate all the bots separately as well as from a given folder and all if its sub-folders in your Control Room repository.
The REST API responds to each request with an HTTP response code. For response codes, see API response codes.

Next steps

View the migration status using the List migration results API.
Send Feedback