活動清單

根據篩選、排序和分頁規則傳回bot執行的清單。獲取部署 API 返回的特定自動化 ID 的執行詳細信息，但 bot 輸出變量和回調信息。

註: 如果要獲取 botOutVariables 或 callbackInfo，請使用活動作業執行.

要求

POST https://{{ControlRoomURL}}/v3/activity/list

Header: X-Authorization <<authentication token>>

所有 API 調用都必須在請求標頭中包含身份驗證令牌。使用身份驗證 API 生成 JSON Web 令牌。看驗證 API.

要求本文：

{
   "sort":[
      {
         "field":"endDateTime",
         "direction":"desc"
      }
   ],
   "filter":{
      "operator":"eq",
      "value":"UPDATE",
      "field":"status"
   },
   "page":{
      "length":100,
      "offset":0
   }
}

使用 automationId、deviceId、status 或 deploymentId 篩選結果。您還可以使用這些過濾器的組合來優化您的搜索結果。

使用部署 ID 的請求正文：

{
  "filter": {
    "operator": "eq",
    "field": "deploymentId",
    "value": "14c2b6f8-c2a0-4a57-959d-ef413df0d179"
  }
}

註: 使用空白篩選或無篩選來擷取搜尋結果中的所有資訊。

請求參數


參數	類型	必填	說明
sort	陣列	否	默認情況下，搜索結果按其 ID 降序排列。使用排序查詢參數指定其他排序方式。輸入要作為排序依據的欄位及其方向為 `asc` (遞增) 或 `desc` (遞減)。有關排序的更多信息，請參閱過濾、分頁和排序.
篩選	物件	否	篩選結果。有關排序的更多信息，請參閱過濾、分頁和排序.
欄位	陣列	否	根據欄位篩選結果。
頁	物件	否	頁面物件可讓您取得所需的頁面。有關分頁規則的更多信息，請參閱過濾、分頁和排序.

回應

200 OK

有關返回碼的更多信息，請參閱 API 響應代碼.

{
    "page": {
        "offset": 0,
        "total": 2387,
        "totalFilter": 2
    },
    "list": [
        {
            "id": "44266e73-4688-4c5a-bad4-11f4c734804d_653a835e07a597fc",
            "automationName": "7 Minutes Bot.22.04.22.13.01.23.chintan-runner",
            "fileName": "7 Minutes Bot",
            "filePath": "",
            "type": "RUN_NOW",
            "startDateTime": "2022-04-22T07:31:44.527762800Z",
            "endDateTime": "1970-01-01T00:00:00Z",
            "command": "",
            "status": "UPDATE",
            "progress": 0,
            "automationId": "",
            "userId": "1141",
            "deviceId": "352",
            "currentLine": 5,
            "totalLines": 0,
            "fileId": "139836",
            "modifiedBy": "1140",
            "createdBy": "1140",
            "modifiedOn": "2022-04-22T07:31:45.265728Z",
            "createdOn": "",
            "deploymentId": "b969e264-65bc-480c-a7db-071bbeedc9ba",
            "queueName": "",
            "queueId": "",
            "usingRdp": false,
            "message": "",
            "canManage": true,
            "deviceName": "AAIN243FQGYE",
            "userName": "joe-doe-runner",
            "tenantUuid": "b6e4eb84-f7ef-4dfd-a432-725b71de8142",
            "automationPriority": "PRIORITY_MEDIUM",
            "callbackInfo": "",
            "runElevated": false,
            "botLabel": "",
            "currentBotName": ""
        },
        {
            "id": "5e55db1e-c6ec-422b-8718-49224b2f3ce3_03a0f7f8bb373597",
            "automationName": "ButtonBot.2022.05.02.08.07.24.ritesh",
            "fileName": "ButtonBot",
            "filePath": "",
            "type": "RUN_NOW",
            "startDateTime": "2022-05-02T15:07:29.004749Z",
            "endDateTime": "1970-01-01T00:00:00Z",
            "command": "",
            "status": "UPDATE",
            "progress": 0,
            "automationId": "",
            "userId": "291",
            "deviceId": "161",
            "currentLine": 0,
            "totalLines": 0,
            "fileId": "142853",
            "modifiedBy": "291",
            "createdBy": "291",
            "modifiedOn": "2022-05-02T08:07:31.548640Z",
            "createdOn": "",
            "deploymentId": "05a192ec-967e-47f3-8b81-185a161d9424",
            "queueName": "",
            "queueId": "",
            "usingRdp": false,
            "message": "",
            "canManage": true,
            "deviceName": "form-builder",
            "userName": "johndoe",
            "tenantUuid": "b6e4eb84-f7ef-4dfd-a432-725b71de8142",
            "automationPriority": "PRIORITY_MEDIUM",
            "callbackInfo": "",
            "runElevated": false,
            "botLabel": "",
            "currentBotName": ""
        }
    ]
}

響應參數


參數	類型	說明
偏移	整數	起始列表偏移量，用於分頁
總計	整數	記錄總數
totalFilter	整數	應用過濾器後的記錄數
清單	陣列	List 活動對象的數組
清單活動物件
ID	整數	特定活動的唯一 ID
automationName	字串	自動化名稱
fileName	字串	Bot 文件名
filePath	字串	的文件路徑 bot 註: 由於 filePath 已過時，請使用獲取直系父母 API，端點： `GET http://{{ControlRoomURL}}/v2/repository/files/{fileid}/parents` 根據輸入文件 ID 檢索文件路徑。
類型	字串	與 bot.以下是 Type： `TASK`：一般bot。 `RUN_NOW`：一個 bot 部署為立即運行 `WLM_TASK`：工作生命週期管理任務 `WORKFLOW`：WLM_TASK 的 `一部分`。 `WORKORDER`：WLM_TASK 的 `一部分` `AARI`：一個過程 bot
startDate	字串	日期和時間 bot 開始
endDate	字串	日期和時間 bot 結束了
command	字串	當前命令 bot 開啟
status	字串	的狀態 bot.以下值是可能的： `COMPLETED`：Bot已成功完成執行。 `DEPLOYED`：自動登錄成功，並且 bot 部署到設備。 `部署失敗`： Bot 未能部署到設備，例如自動登錄失敗。 `QUEUED`：請求的用戶或設備正忙於運行另一個執行 `PENDING_EXECUTION`：已選擇設備，但 bot 尚未部署到該設備 `RUNNING` 或 `UPDATE`：正在裝置上執行Bot。 `RUN_FAILED`：Bot在部署至裝置後失敗。 `RUN_PAUSED`：用戶暫停 bot. `RUN_TIMED_OUT`：Bot無法在特定期間內完成任務。 `UNKNOWN`：服務和設備之間的連接丟失。
progress	整數	的進展 bot 百分比。
totalLines	整數	命令行總數 bot 包含。
currentLine	整數	當前行 bot 正在處理。
timeTaken	整數	以毫秒為單位的時間 bot 完成操作。
progress	整數	的進展 bot 百分比。
automationId	整數	自動化的 ID。
userId	整數	用戶的 ID。
deviceId	整數	設備的 ID。
fileId	整數	bot檔案的唯一識別碼。
modifiedBy	整數	修改活動的用戶的 ID。
createdBy	整數	創建活動的用戶的 ID。
modifiedOn	字串	修改時的時間戳。
createdOn	字串	建立活動的時間戳記。
deploymentId	字串	部署ID bot.
queueName	字串	佇列的名稱。
queueId	字串	隊列的 ID。
usingRdp	布林值	顯示是否 bot 正在使用遠程部署協議。
message	字串	傳回執行狀態詳細資料的錯誤訊息。
canManage	布林值	標誌以顯示是否 bot 可以管理。
deviceName	字串	裝置的名稱。
userName	字串	正在運行的用戶的用戶名 bot.
tenantUuid	字串	租用戶的唯一 UUID。
automationPriority	字串	自動化優先級。此值預設為 `PRIORITY_MEDIUM`。`AutomationPriority`可能值包括：`PRIORITY_MEDIUM`、 `PRIORITY_HIGH` 和 `PRIORITY_LOW`。
callbackInfo	物件	該參數沒有返回值；將需要個人 bot 用於檢索該信息的 API
runElevated	布林值	標誌顯示是否 bot 是否使用提升的權限進行部署。可能的值包括 `false` 和 `true`。
botLabel	字串	標籤為 bot.可以用來區分 bots 從生產和測試等類別。
currentBotName	字串	目前的名稱 bot.它可以在執行期間更改。

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

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