Read and Review Automation Anywhere Documentation

Automation Anywhere Version 11.3

Close Contents

Contents

Open Contents

Repository Management API overview

  • Updated: 5/12/2020
    • 11.3.x
    • Explore
    • Enterprise
    • Overviews

Repository Management API overview

Use the Repository Management API to programmatically delete a file, retrieve bot variables, return a list of files and folders in a folder, and search for files and folders in your Control Room.

Repository URLs

Search for folders and files in your Control Room repository
POST http://<your_control_room_url>/v1/repository/filefolder/list 
Body parameters: This request body example includes filters, sorting, and page control to refine the response.
{
  "filter": {
    "operator": "NONE",
    "operands": [
      null
    ],
    "field": "string",
    "value": "string"
  },
  "sort": [
    {
      "field": "string",
      "direction": "asc"
    }
  ],
  "page": {
    "offset": 0,
    "length": 0
  }
}

Filters allow you to refine what is returned in the response body. Read more about filters in Filters in an API request body.

Note: You can filter by the following fields: parentId, path, name, lastModified, and directory.
See Use filters to list specific files.
Return a list of folders and files in a directory
POST http://<your_control_room_url>/v1/repository/directories/{directoryid}/files/list
URL parameter:

.../directories/{directoryid}/files/list...: The numeric value that identifies the directory position.

Body parameters: This request body example includes filters, sorting, and page control to refine the response.
{
  "filter": {
    "operator": "NONE",
    "operands": [
      null
    ],
    "field": "string",
    "value": "string"
  },
  "sort": [
    {
      "field": "string",
      "direction": "asc"
    }
  ],
  "page": {
    "offset": 0,
    "length": 0
  }
}

Filters allow you to refine what is returned in the response body. Read more about filters in Filters in an API request body.

Note: You can filter by the following fields: parentId, path, name, lastModified, and directory.
See Use filters to list bots from a specific folder.
Delete a repository file
DELETE http://<your_control_room_url>/v1/repository/files/{aafileid}
URL parameter:

.../files/{aafileid}...: The numeric value that identifies the file.

Note: You cannot delete folders with an ID less than 9.

See Delete a file from the repository.

Retrieve a list of bot variables
GET http://<your_control_room_url>/v1/repository/file/{fileId}/variables/{fileVersion}
URL parameter:

.../file/{fileId}/variables/{fileVersion}...: The numeric value in {fileId} that identifies the file and the string in {fileVersion} that specifies the version. The file version can either be latest or production. The default value is latest.

Note: This endpoint can only retrieve string, list, and array variables.
See Retrieve a list of variables.
Send Feedback