閱讀及檢閱 Automation Anywhere 文件

Automation Anywhere Automation 360

關閉內容

內容

開啟內容

按工作空間 API 列出文件和文件夾

  • 已更新:2021/01/19

    按工作空間 API 列出文件和文件夾

    返回 bots公共或私有工作空間中對象(文件、文件夾和)的詳細信息。此端點返回對象 ID,該 ID 是在其他 API 中用於標識文件、文件夾或 bot的數值。

    先決條件

    註: 您可以在中查看, Control Room APIs Community Edition但 API 功能受限。您需要授權 Automation 360 版本才能存取 API 的完整功能。
    • 使用 驗證 API 來產生 JSON Web Token 。
    • 若要檢視私人工作區中的物件、您必須擁有 Bot Creator 授權和角色、其中包含 「檢視我的機器人程式 」功能權限。
    • 若要檢視公用工作區中的物件、您必須指派一個角色、其中包含 檢視我的機器人程式 功能權限、 以及檢視 bot 公用工作區中資料夾的內容權限。

    程序

    1. 將驗證令牌添加到請求標頭。
    2. 使用 POST 方法和端點 URL : <control_room _url>/v2/repository/workspace/ { workspaceType } / 檔案 / 清單
      { workspaceType } 指定要在公用或私人工作區中搜尋。

      以下示例請求搜索 名稱中包含字符串 finance 的對象。

      請求主體
      {
        "filter": {
            "operator": "substring",
            "field": "name",
            "value": "finance"
            }
        }

      支持的可過濾字段

    3. 發送請求。
      回應本文:
      在此範例回應中 , 此端點會傳回 bot 物件 識別碼 為 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:父文件夾的唯一數字標識符。
      • 文件夾:布爾值, 如果對象是文件夾則返回 true , 如果是 bot 或其他文件則返回 false 。
      REST API 會以 HTTP 回應碼回應每個要求。有關響應代碼的詳細信息,請參見 API 回應碼

    後續步驟

    如果您要執行執行執行 bot 或建立自動化排程的步驟,請執行下列工作: 列出可用的無人值守 Bot Runners API

    傳送意見反饋