Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

List details about files, folders, and bots API

  • Updated: 1/19/2021
    • Automation 360 v.x
    • Explore
    • RPA Workspace

List details about files, folders, and bots API

Return details about all the objects (bots, folders, and files) in the Control Room. This endpoint returns the object id, which is a numeric value that is used in other APIs to identify the file, folder or bot.

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.
  • Use the Authentication API to generate a JSON Web Token. See Authentication API.
  • To view objects in your private workspace, you must have a Bot Creator license and a role that includes the View my bots feature permission.
  • To view objects in the public workspace, you must be assigned a role that includes the View my bots feature permission and the View content bot permission to folders in the public workspace.

Use filters such as bot names, folder paths, and IDs to narrow down the results. Supported filterable fields

Procedure

  1. Add the authentication token to the request header.
  2. Use the POST method and endpoint URL: <control_room_url>/v2/repository/file/list
    Request body: The following example request searches for objects that contain the string finance in the path.
    {
      "filter": {
        "operator": "substring",
        "field": "path",
        "value": "finance"
      }
    }
  3. Send the request.
    Response body: The id in the following response is the unique identifier for the bot.
    In this example response, the endpoint returns a bot with an object id of 12.
    {
      "page": {
        "offset": 0,
        "total": 4,
        "totalFilter": 1
      },
      "list": [
        {
          "id": "12",
          "parentid": "11",
          "name": "FinanceHelloWorldGBG.atmx",
          "permission": {
            "delete": false,
            "download": true,
            "execute": false,
            "upload": true,
            "run": false
          },
          "lastModified": "2020-01-08T22:24:08.060Z",
          "lastModifiedBy": "10",
          "path": "Automation Anywhere\\My Tasks\\Finance\\FinanceHelloWorldGBG.atmx",
          "directory": false,
          "size": 4578,
          "locked": false,
          "fileLastModified": "2020-01-08T22:21:58Z",
          "isProtected": false
        }
      ]
    }
    The REST API responds to each request with an HTTP response code. For details about the response codes, see API response codes.
Send Feedback