Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Import files using API

  • Updated: 1/28/2021
    • Automation 360 v.x
    • Explore
    • RPA Workspace
    • API docs

Import files using API

You can import bots with their dependent files using the Import API.

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.
  • You must have following permissions and licenses:
    • Import bots
    • Manage package
    • Check in permissions to the necessary folders to import bots in the public workspace
    • Bot Creator license to import bots in the private workspace
  • Use the Authentication API to generate a JSON Web Token. See Authentication API.
  • The following API URLs:
    • https://<your_control_room_url>/v2/blm/import: To import repository bot
    • https://<your_control_room_url>/v2/blm/status/{requestId}: To get import status by request ID
  • To import the Enterprise 11 bots into your Control Room, you must have the required aapkg package that you created using the BLM Export API in the Enterprise 11 Control Room instance.

    The aapkg package must be present in the same Automation 360 machine where you want to import the Enterprise 11 bots.

    You can import the password-protected aapkg packages using the Import API only.

Procedure

  1. Add the authentication token to the request header.
  2. Use the POST method and endpoint URL: https://<your_control_room_url>/v2/blm/import.
    Provide the following parameters for the request header.
    • upload: Choose the required zip file that you want to import in your Control Room.

      Choose the required aapkg file to import Enterprise 11 bots to your Control Room.

    • actionIfExisting: Select either the SKIP or OVERWRITE option if the file you are importing already exists.
    • publicWorkspace: This is a Boolean value. Select either true or false. Enter true if you want to import the file to the public workspace.
  3. Send the request.
    The following response body returns requestId.
    Response body:
    {
      "requestId": "eafef543-2d7a-47f5-81d0-490d09dd68d2"
    }
  4. Use the GET method and endpoint URL: <your_control_room_url>/v2/blm/status/{requestId}
    Enter the requestId generated in Step 3 to know the status of import.
  5. Send the request.
    The following response body returns the status.
    Response body:
    {
        "requestId": "fa4b0c56-fab8-42ef-8d96-fc6b53e1cbaa",
        "type": "IMPORT",
        "status": "COMPLETED",
        "downloadFileName": "",
        "downloadFileId": "",
        "errorMessage": ""
    }

    The COMPLETED status indicates that the file is successfully imported. You can find the imported file in your Control Room

    Enterprise 11 bots migration:
    1. The Enterprise 11 bots are imported in the Bots > My Tasks folder or Bots > My Metabots folder in the .atmx or .mbot file format.
    2. Use the migration wizard to convert the Enterprise 11 bots files into the .bot format that is supported in Automation 360.

    The REST API responds to each request with an HTTP response code. For response codes, see API response codes.

Send Feedback