阅读和查看 Automation Anywhere 文档

Automation Anywhere Automation 360

关闭内容

内容

打开内容

按工作区 API 列出文件和文件夹

  • 已更新:1/19/2021
    • Automation 360 v.x
    • 管理
    • RPA 工作区
    • API 文档

按工作区 API 列出文件和文件夹

在公共工作区或私有工作区中返回有关对象(文件、文件夹和 bots)的详细信息。此端点返回对象 ID,这是在其他 API 中用于标识文件、文件夹或 bot 的数值。

先决条件

注: 您可以在 Control Room APIs 中查看 Community Edition,但 API 功能有限。您需要获得许可证的 Automation 360 Edition 才能访问 API 的全部功能。
  • 使用身份验证 API 生成 JSON Web 令牌。请参阅身份验证 API
  • 要查看您私有工作空间中的对象,您必须具有Bot Creator许可证和包含查看我的机器人功能权限的角色。
  • 要查看公共工作空间中的对象,您必须分配到一个角色,其中包含查看我的机器人功能权限和查看公共工作空间中文件夹的内容bot权限。

过程

  1. 将认证令牌添加到请求标头。
  2. 使用 POST 方法和端点 URL: <control_room_url>/v2/repository/workspaces/{workspaceType}/files/list
    {workspaceType} 指定是在公共工作区还是在私有工作区中搜索。

    以下请求示例将搜索名称中包含字符串函数的对象。

    请求正文:
    {
      "filter": {
          "operator": "substring",
          "field": "name",
          "value": "finance"
          }
      }

    支持的可筛选字段

  3. 发送请求
    响应正文:
    在本示例响应中,此端点返回的对象 ID 为 14277 的 bot
    {
        "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
            }
        ]
        }

    响应参数

    • id:匹配搜索参数的对象的唯一数字标识符。
    • parentId:父文件夹的唯一数字标识符。
    • folder:一个布尔值,如果对象是文件夹,则返回 true,如果是 或其他文件,则返回 falsebot
    REST API 用 HTTP 响应代码响应每个请求。有关响应代码的详细信息,请参阅 API 响应代码

后续步骤

如果您正在执行运行 bot 或创建自动化计划的步骤,请执行此任务:列出可用的无人值守Bot Runners API

发送反馈