Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Migrate all bots in a sub-folder API

  • Updated: 2/04/2021
    • Automation 360 v.x
    • Manage
    • RPA Workspace

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.

Prerequisites

  • Find the folder ID you want to migrate. The List files and folders by workspace API searches for files and folders in the private or public Control Room repositories. Filter the results to identify the folder ids to be used in the request body.
  • For one or more users with a RUNTIME device license. Use userIds for registered users in the Control Room as unattended bot runners with a RUNTIME device license and registered device. Search for users API
  • You must have an admin role to migrate bots and folders.

Procedure

  1. Add the authentication token to the request header.
  2. Use the POST method and endpoint URL: <your_control_room_url>/v3/migration/start

    Request parameters:

    Parameter Required Type Description
    folderIds Yes Integer Folder IDs for all the bots contained in the sub-folder with the folderIds.
    userIds Yes Integer User IDs for an unattended Bot Runner user.
    includeChildFolders No Boolean

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

    This following request starts a migration for all the bots contained in the sub-folder with the folderIds: 7 and userIds: 18.

    Request body:

    {
      "name": "Follow a convention that is meaningful and easy to search.",
      "description": "Add a meaningful description.",
      "overwriteBots": true,
      "userIds": [
        18
      ],
      "folderIds": [
        7
      ],
      "includeChildFolders": true
    }
  3. Send the request.
    The successful response includes a 200 success code and an empty body.
    { }
The REST API responds to each request with an HTTP response code. For response codes, see API response codes.

Next steps

You can view the status of the migration using the List migration results API API.
Send Feedback