Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Repository management filter example

  • Updated: 3/15/2021
    • Automation 360 v.x
    • Manage
    • RPA Workspace
    • Examples

Repository management filter example

This example filter is based on the Repository Management API fields and parameters. This filter example searches the bot status and the name.

This filter searches for bots in the Control Room repository with the string "finance" in the name of the file that have a status of "CHECKED_OUT."
Note: The Repository management API uses role based access. That means users can only see the files and folders to which they have access.
{
  "sort": [
    {
      "field": "directory",
      "direction": "desc"
    },
    {
      "field": "name",
      "direction": "asc"
    }
  ],
  "filter": {
    "operator": "and",
    "operands": [
      {
        "operator": "substring",
        "value": "finance",
        "field": "name"
      },
      {
        "operator": "eq",
        "value": "CHECKED_OUT",
        "field": "botStatus"
      }
    ]
  }
}
sort
  • field: the name of the field used to sort the response.
  • direction: the sort order. It can be asc, ascending, or desc, descending.
filter

Filter consists for an operator, value, and field. Filters are operands when used in conjunction with a boolean operator, such as and.

  • operands: filters are used as operands when combined in a filter by using a boolean operator. There are two available boolean operators:
    • or: one of the conditions must be met.
    • and: all of the conditions must be met.
  • operator: there are 11 operators NONE, lt, le, eq, ne, ge, gt, substring, and, or, not. And and or are used to evaluate multiple filters together. The other operators are used to evaluate values within individual filters. Not all operators work with all fields.
  • field: the name of the field used in the filter.
  • value: the value of the field to be evaluated.
Send Feedback