阅读和查看 Automation Anywhere 文档

Automation 360

关闭内容

内容

打开内容

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

  • 已更新:2021/01/19
    • Automation 360 v.x
    • 管理
    • RPA Workspace
    • API 文档

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

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

先决条件

注: 您可以查看 Control Room APIs 在里面 Community Edition,但 API 功能有限。你需要有执照的 Automation 360 用于访问 API 全部功能的版本。
  • 所有 API 调用都必须在请求标头中包含身份验证令牌。使用 身份验证 API 生成 JSON Web 令牌。 看 身份验证 API.
  • 要查看私有工作区中的对象,您必须拥有 Bot Creator 许可证和包含 查看我的机器人 功能权限的角色。
  • 要查看公共工作区中的对象,必须为您分配一个角色,该角色包括 查看我的机器人 功能权限和 查看内容bot 公共工作区中文件夹的权限。

过程

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

    以下示例请求搜索名称中包含字符串 Finance

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

    支持的可过滤字段

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

发送反馈