Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Export files using API

  • Updated: 3/08/2021
    • Automation 360 v.x
    • Explore
    • RPA Workspace
    • API docs

Export files using API

You can export bots with their dependent files using the Export 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 Export bots, View package, and Check in or Check out permissions to the required folders.
  • Use the Authentication API to generate a JSON Web Token. See Authentication API.
  • A file ID of the bot you want to export from the public folder.

    List files and folders by workspace API

    Note: Users can only view the folders and subfolders they have permissions to access.
  • The following API URLs:
    • https://<your_control_room_url>/v2/blm/export: To export repository bots
    • https://<your_control_room_url>/v2/blm/status/{requestId}: To get export status by request ID
    • https://<your_control_room_url>/v2/blm/downoad/{downloadFileId}: To download the exported bot

Procedure

  1. Add the authentication token to the request header.
  2. Search for one or more file IDs of the bot you want to export.
  3. Use the POST method and endpoint URL:https://<your_control_room_url>/v2/blm/export.
    The following example request body, exports the bot with fileId 2197 along with the packages required for bot.

    Request body:

    {
      "name": "export-docs",
      "fileIds": [
        2197
      ],
      "includePackages": true
    }
  4. Send the request.
    The following response body returns the requestId.
    Response body:
    {
      "requestId": "987c0de3-b158-4e71-975e-27d10b9a83fb"
    }
  5. Use the GET method and endpoint URL: <your_control_room_url>/v2/blm/status/{requestId}
    Enter the requestId generated in Step 4 to know the status of export.
    https://192.0.2.0/v2/blm/status/987c0de3-b158-4e71-975e-27d10b9a83fb
  6. Send the request.
    The following response body returns the status and downloadFileId.
    Response body:
    {
      "requestId": "987c0de3-b158-4e71-975e-27d10b9a83fb",
      "type": "EXPORT",
      "status": "COMPLETED",
      "downloadFileName": "export-docs",
      "downloadFileId": "ZXhwb3J0LWRvY3M=",
      "errorMessage": ""
    }
  7. Use the GET method and endpoint URL: <your_control_room_url>/v2/blm/download/{downloadFileId}
    Enter the downloadFileId generated in Step 6.
    https://192.0.2.0/v2/blm/download/ZXhwb3J0LWRvY3M=
  8. Send the request.
    The dialog box appears. Browse the path and save the exported package in zip file format.

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

Next steps

Import the exported file in the private folder of the target Control Room.
Send Feedback