列出文件 API

使用列表文件 API 查看所有對象（文件、文件夾或 bot）在裡面 Control Room.此 API 返回一個 id 參數作為響應，它是一個數值，可以在不同的 API 中用於標識文件、文件夾或 bot.

註: 列表文件 API 將從版本 Automation 360 v.29 開始棄用。此 API 具有以下限制：

如果您將其用作 AAE_Admin，則可以在響應中查看私有存儲庫中的機器人程序。
如果您將其用作機器人創建者，則可以在響應中查看系統機器人（記錄器）。

作為解決方法，您可以使用通過工作區 API 列出文件和文件夾.

要求

POST http://{{ControlRoolURL}}/v2/repository/file/list

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<bearer token>>

所有 API 調用都必須包含來自驗證 API （生成 JSON Web 令牌）或來自 OAuth 服務的不記名令牌。您不能在 API 中同時使用兩者。

要查看私人工作區中的對象，您必須擁有 Bot Creator 許可和包含 查看我的機器人 功能權限的角色。
要查看公共工作區中的對象，必須為您分配一個角色，該角色包括 查看我的機器人 功能權限和 查看內容 bot 對公共工作區中文件夾的權限。

您可以發送帶或不帶過濾器參數的 API 請求。未指定任何過濾器參數的 API 請求會檢索 Control Room.您可以使用過濾器參數來檢索一組特定的文件或文件夾對象，而不是獲取 Control Room.如需詳細資訊，請參閱篩選、分頁和排序。

沒有過濾器的請求正文：

{
    "filter": null,
    "sort": [
        {
            "field": "directory",
            "direction": "desc"
        },
        {
            "field": "name",
            "direction": "asc"
        }
    ],
    "page": {
        "offset": 0,
        "length": 100
    }
}

帶過濾器的請求正文：

{
    "filter": {
        "operator": "substring",
        "value": "bot",
        "field": "name"
    },
    "sort": [
        {
            "field": "directory",
            "direction": "desc"
        },
        {
            "field": "name",
            "direction": "asc"
        }
    ],
    "page": {
        "offset": 0,
        "length": 100
    }
}

請求參數


參數	類型	必填	說明
篩選	物件	否	根據運算符、字段或值過濾結果。操作員允許的枚舉是 NONE、lt、le、eq、ne、ge、gt、substring 和、or、not。場地允許的值為名稱、lastModified、路徑或文件夾。價值為您在字段參數中選擇的名稱、lastModified、路徑或文件夾指定一個值。
sort	陣列	否	默認情況下，搜索結果按其 ID 降序排列。要指定替代排序，請使用排序查詢參數。輸入要作為排序依據的欄位及其方向為 `asc` (遞增) 或 `desc` (遞減)。
頁	物件	否	頁面物件可讓您取得所需的頁面。

回應

{
    "page": {
        "offset": 0,
        "total": 4619,
        "totalFilter": 100
    },
    "list": [
        {
            "id": "137169",
            "parentId": "111492",
            "name": ".25Bot",
            "permission": {
                "delete": true,
                "download": true,
                "upload": true,
                "run": true,
                "publishBotstore": false
            },
            "lastModified": "2022-04-11T10:28:18.098323Z",
            "lastModifiedBy": "291",
            "path": "Automation Anywhere\\Bots\\.25Bot",
            "directory": false,
            "size": "2615",
            "locked": false
        }
]}

響應參數


參數	類型	說明
偏移	整數	用於分頁的開始清單偏移值。
總計	整數	記錄總次數。
totalFilter	整數	套用篩選後的記錄次數。
清單	陣列	目錄和文件的列表。
列出對象
ID	整數	顯示對象的唯一ID（bots、文件夾或文件）。
parentId	整數	父文件夾的唯一 ID。
名稱	字串	文件或文件夾的名稱。
允許	物件	顯示值為 True 或 False 的當前用戶的權限：刪除指示當前登錄用戶是否具有刪除機器人的權限。下載指示當前登錄的用戶是否有權下載（簽出）機器人。上傳指示當前登錄的用戶是否有權上傳（簽入）機器人。執行指示當前登錄的用戶是否有權運行或安排機器人。發布Botstore 指示當前登錄用戶是否有權將機器人發佈到機器人商店。
lastModified	整數	上次更新機器人的日期和時間。
最近一次修改者：	字串	上次更新機器人或文件的用戶的 ID。
path	整數	存儲庫中文件或文件夾的路徑。
directory	字串	目錄標誌。
size	整數	文件的大小。僅當項目類型為文件時才可用。
鎖定	字串	指示文件是否被鎖定。僅當項目類型為文件時才可用。

註: 您可以查看 Control Room APIs 在裡面 Community Edition，但 API 功能有限。你需要一個許可 Automation 360 版本以訪問 API 的全部功能。

REST API 使用 HTTP 響應代碼響應每個請求。有關響應代碼，請參閱 API響應代碼.