Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

List files and folders by workspace API

  • Updated: 1/19/2021
    • Automation 360 v.x
    • Manage
    • RPA Workspace
    • API docs

List files and folders by workspace API

Return details on objects (files, folders, and bots) in either the public or private workspace. 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.

Procedure

  1. Add the authentication token to the request header.
  2. Use the POST method and endpoint URL: <control_room_url>/v2/repository/workspaces/{workspaceType}/files/list
    {workspaceType} specifies whether to search in the public or private workspace.

    The following example request searches for objects that contain the string finance in the name.

    Request body:
    {
      "filter": {
          "operator": "substring",
          "field": "name",
          "value": "finance"
          }
      }

    Supported filterable fields

  3. Send the request.
    Response body:
    In this example response, this endpoint returns a bot with the object id of 14277.
    {
        "page": {
            "offset": 0,
            "total": 1114,
            "totalFilter": 1
        },
        "list": [
            {
                "id": "14277",
                "parentId": "9",
                "name": "financeWeeklyReport",
                "path": "Automation Anywhere\\Bots\\exampleBots",
                "description": "v1",
                "type": "application/vnd.aa.taskbot",
                "size": "799",
                "folder": false,
                "folderCount": "0",
                "productionVersion": "",
                "latestVersion": "",
                "locked": false,
                "lockedBy": "0",
                "createdBy": "22",
                "lastModifiedBy": "22",
                "lastModified": "2020-10-21T17:42:10.140037Z",
                "permission": {
                    "delete": false,
                    "download": false,
                    "upload": false,
                    "run": true,
                    "publishBotstore": false,
                    "viewContent": false,
                    "clone": false
                },
                "workspaceId": "0",
                "botStatus": "PUBLIC",
                "hasErrors": false,
                "workspaceType": "UNKNOWN",
                "metadata": false,
                "uri": "",
                "version": "3",
                "hasTriggers": false,
                "isModified": false
            }
        ]
        }

    Response parameters:

    • id: a unique numeric identifier for the object that matches the search parameters.
    • parentId: a unique numeric identifier for the parent folder.
    • folder: a boolean value that returns true if the object is a folder and false if it is a bot or other file.
    The REST API responds to each request with an HTTP response code. For details about the response codes, see API response codes.

Next steps

If you are performing the steps to run a bot or to create an automation schedule, perform this task: List available unattended Bot Runners API

Send Feedback