Request details about files, folders and bots

Request details about bots, folders, and files by searching by names, relative paths, and ids in the Control Room where they are stored.

Prerequisites

Use the bot names, folder paths and ids to retrieve detailed information.
Roles and license

You need to authenticate as a user that has a Bot runner (Run time with TaskBots and MetaBots) license.

  • URL:
    http://<your_control_room_url>/v2/repository/file/list
  • Method: POST
Supported filterable fields:
path
This example searches for the string Finance in the path parameter. This search is not case sensitive. It finds Finance or finance.
  • Field: path
  • Type: string 
{
  "filter": {
    "operator": "substring",
    "value": "Finance",
    "field": "path"
  }
}
name
Retrieve all the bots with 'HR' in their name. For example, Automation Anywhere\My Tasks\Bots\HR-daily.atmx
  • Field: name
  • Type: string 
{
  "filter": {
    "operator": "substring",
    "field": "name",
    "value": "HR"
  }
}
directory
The value false will get all files (and not directories); if the value is true, then it will return all the directories
  • Field: directory
  • Type: boolean 
{
  "filter": {
    "operator": "eq",
    "field": "directory",
    "value": "false"
  }
}
parentId
This will get all the bots/files with parentid as 7
  • Field: parentid
  • Type: long 
{
  "filter": {
    "operator": "eq",
    "field": "parentid",
    "value": "7"
  }
}
lastModified
This will get all the bots/files which were last modified at that date-time
  • Field: lastModified
  • Type: date-time 
{
  "filter": {
    "operator": "gt",
    "field": "lastModified",
    "value": "2022-01-07T18:00:00Z"
  }
}

Use the following fields to filter the response.

name: The partial or full name of a bot. You can search on the exact name (eq) or a text string (substring) that is contained in the bots name.

The following request returns a detailed list of all the bots that are in any folder that contains Finance in the folder path.

Procedure

  1. Add an authentication token to the request header.
    Note: Use the Enterprise 11 Authentication API to generate a JSON Web Token.
  2. Enter the URL for the API http://<your_control_room_url>/v2/repository/file/list.
  3. Select the POST method.
  4. In the request body, the substring "finance" is used to search for folder paths that contain the string. 
    {
  "filter": {
    "operator": "substring",
    "field": "path",
    "value": "finance"
  }
}
  5. Send the request.
    • In a REST client, click SEND.
    • In the Swagger interface, click Execute.
    Response body:

    The id in the response below is the unique identifier for the bot. In this response there are two bots listed.

    {
  "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": "2022-01-08T22:24:08.060Z",
      "lastModifiedBy": "10",
      "path": "Automation Anywhere\\My Tasks\\Finance\\FinanceHelloWorldGBG.atmx",
      "directory": false,
      "size": 4578,
      "locked": false,
      "fileLastModified": "2022-01-08T22:21:58Z",
      "isProtected": false
    }
  ]
}
Response Parameters
Parameter Type Description
offset Integer The starting list offset, used for pagination.
total Integer Total number of records.
totalFilter Integer Number of records after applying the filter.
List Array The array of List files object.
List files object
id Integer The unique Id of a file.
name String Name of file.
lastModifiedBy Integer Id of the user who last modified the file.
path String The path of the file.
size Integer The size of the file.

Next steps

To deploy a specific bot, use the numeric id of the bot. Here are some additional requests for retrieving detailed bot information.