Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Repository Management APIs

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

Repository Management APIs

Use the Repository Management APIs to return information on or to delete the objects (bots, folders, and files) that you have permissions to access in the Control Room.

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.
The Automation 360 repository is comprised of the private and public workspaces, which contain folders of bots (.atmx) and their dependency files. The private workspace holds objects that are only accessible to the logged-in user. Bots in the private workspace can only be run on that user's device. The public workspace holds objects that are accessible to all users who have the necessary permissions. When a bot is checked-in from a private workspace to the public workspace, it can be checked out by another user to their private workspace for editing or deployed to a Bot Runner.
Note:
  • 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.

Choosing a Repository Management list API

The following Repository Management APIs return information on objects (bots, files, and folders), based on the access granted by the user's role.

Supported filterable fields

Use the following filters in the request bodies of the list APIs to narrow down the response data.

createdBy
The numeric identifier for the user who created a folder or bot.
{
  "operator": "eq",
  "field": "createdBy",
  "value": "2587"
}
folder
This example searches for only folders. Set the value to false to search for only bots and files.
{
  "operator": "eq",
  "field": "folder",
  "value": "true"
}
name
This example searches for objects that are named Finance or finance. This search is not case-sensitive.
  • Field: name
  • Type: string
{
  "filter": {
    "operator": "eq",
    "value": "finance",
    "field": "name"
  }
}
path
This example searches for objects that contain the string Finance in the path parameter. This search is not case-sensitive.
  • Field: path
  • Type: string
{
  "filter": {
    "operator": "substring",
    "value": "Finance",
    "field": "path"
  }
}
Send Feedback