活動列表（已棄用）

根據篩選、排序和分頁規則傳回bot執行的清單。擷取由部署 API 傳回之特定自動化 ID 的執行作業詳細資訊。

由於在使用此端點活動列表 API (/v2/activity/list) 時觀察到的挑戰，特別是在使用帶有大型表的botOutVariables輸出變量的大小應限制為 3 MB - 有關詳細信息，請參閱您的變數 (使用者定義).

註: 此 API /v2/activity/list 現在處於日落階段，將從將於 12 月發布的版本 A360.27 中刪除（2023 年 1 月在 A360 Cloud 上）。作為替代方案，使用新的活動清單.

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

要求

POST https://{{ControlRoomURL}}/v2/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 篩選結果。您也可以使用這些篩選組合來最佳化您的搜尋結果。

使用 deploymentId 的要求本文：

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

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

要求參數


參數	類型	必填	說明
sort	陣列	否	依預設，搜尋結果會依其 ID 以遞減順序排序。使用排序查詢參數指定其他排序方式。輸入要作為排序依據的欄位及其方向為 `asc` (遞增) 或 `desc` (遞減)。
篩選	物件	否	篩選結果。
欄位	陣列	否	根據欄位篩選結果。
頁	物件	否	頁面物件可讓您取得所需的頁面。

如需有關篩選、分頁和排序的詳細資訊，請參閱過濾、分頁和排序。

回應

200 OK

如需傳回碼的詳細資訊，請參閱API 響應代碼。

{
   "page":{
      "offset":0,
      "total":820,
      "totalFilter":1
   },
   "list":[
      {
         "id":"fe299c90-9ce0-4838-afb3-72445b2735b2_9b0c638c47251ef4",
         "automationName":"REST-Web-Service.2022.05.26.23.52.57.AA_user",
         "fileName":"REST-Web-Service",
         "filePath":"",
         "type":"RUN_NOW",
         "startDateTime":"2022-05-26T23:52:58.724951900Z",
         "endDateTime":"2022-05-26T23:54:51.928431Z",
         "command":"messageBox",
         "status":"COMPLETED",
         "progress":100,
         "automationId":"",
         "userId":"21",
         "deviceId":"1",
         "currentLine":2,
         "totalLines":2,
         "fileId":"121",
         "modifiedBy":"21",
         "createdBy":"21",
         "modifiedOn":"2022-05-26T23:54:54.031638Z",
         "createdOn":"2022-05-26T23:52:57.811649Z",
         "deploymentId":"6ac7ff1d-9bbb-4c59-875c-3981a6eabd7c",
         "queueName":"",
         "queueId":"",
         "usingRdp":false,
         "message":"",
         "canManage":true,
         "deviceName":"AAUS3414D0D7",
         "userName":"AA_user",
         "botOutVariables":{
            "values":{
               "Output":{
                  "type":"DICTIONARY",
                  "expression":"",
                  "string":"",
                  "number":"",
                  "boolean":"",
                  "repository":"",
                  "variableName":"",
                  "packageId":"",
                  "packageName":"",
                  "iteratorId":"",
                  "iteratorName":"",
                  "conditionalId":"",
                  "conditionalName":"",
                  "list":[
                     
                  ],
                  "dictionary":[
                     {
                        "key":"Response",
                        "value":{
                           "type":"STRING",
                           "expression":"",
                           "string":"HTTP/ 200 OK",
                           "number":"",
                           "boolean":"",
                           "repository":"",
                           "variableName":"",
                           "packageId":"",
                           "packageName":"",
                           "iteratorId":"",
                           "iteratorName":"",
                           "conditionalId":"",
                           "conditionalName":"",
                           "list":[
                              
                           ],
                           "dictionary":[
                              
                           ],
                           "exceptionName":"",
                           "thumbnailMetadataPath":"",
                           "screenshotMetadataPath":"",
                           "properties":[
                              
                           ],
                           "triggerName":"",
                           "formElementId":"",
                           "formElementType":"",
                           "formInstanceId":"",
                           "queueName":"",
                           "taskbotSelf":false,
                           "variableMapFilter":[
                              
                           ],
                           "sessionTarget":"NONE",
                           "securelyRecorded":false
                        }
                     },
                     {
                        "key":"Date",
                        "value":{
                           "type":"STRING",
                           "expression":"",
                           "string":"Thu, 26 May 2022 23:53:01 GMT",
                           "number":"",
                           "boolean":"",
                           "repository":"",
                           "variableName":"",
                           "packageId":"",
                           "packageName":"",
                           "iteratorId":"",
                           "iteratorName":"",
                           "conditionalId":"",
                           "conditionalName":"",
                           "list":[
                              
                           ],
                           "dictionary":[
                              
                           ],
                           "exceptionName":"",
                           "thumbnailMetadataPath":"",
                           "screenshotMetadataPath":"",
                           "properties":[
                              
                           ],
                           "triggerName":"",
                           "formElementId":"",
                           "formElementType":"",
                           "formInstanceId":"",
                           "queueName":"",
                           "taskbotSelf":false,
                           "variableMapFilter":[
                              
                           ],
                           "sessionTarget":"NONE",
                           "securelyRecorded":false
                        }
                     },
                     {
                        "key":"Access-Control-Allow-Methods",
                        "value":{
                           "type":"STRING",
                           "expression":"",
                           "string":"GET, POST, DELETE, PUT",
                           "number":"",
                           "boolean":"",
                           "repository":"",
                           "variableName":"",
                           "packageId":"",
                           "packageName":"",
                           "iteratorId":"",
                           "iteratorName":"",
                           "conditionalId":"",
                           "conditionalName":"",
                           "list":[
                              
                           ],
                           "dictionary":[
                              
                           ],
                           "exceptionName":"",
                           "thumbnailMetadataPath":"",
                           "screenshotMetadataPath":"",
                           "properties":[
                              
                           ],
                           "triggerName":"",
                           "formElementId":"",
                           "formElementType":"",
                           "formInstanceId":"",
                           "queueName":"",
                           "taskbotSelf":false,
                           "variableMapFilter":[
                              
                           ],
                           "sessionTarget":"NONE",
                           "securelyRecorded":false
                        }
                     },
                     {
                        "key":"Access-Control-Allow-Headers",
                        "value":{
                           "type":"STRING",
                           "expression":"",
                           "string":"Content-Type, api_key, Authorization",
                           "number":"",
                           "boolean":"",
                           "repository":"",
                           "variableName":"",
                           "packageId":"",
                           "packageName":"",
                           "iteratorId":"",
                           "iteratorName":"",
                           "conditionalId":"",
                           "conditionalName":"",
                           "list":[
                              
                           ],
                           "dictionary":[
                              
                           ],
                           "exceptionName":"",
                           "thumbnailMetadataPath":"",
                           "screenshotMetadataPath":"",
                           "properties":[
                              
                           ],
                           "triggerName":"",
                           "formElementId":"",
                           "formElementType":"",
                           "formInstanceId":"",
                           "queueName":"",
                           "taskbotSelf":false,
                           "variableMapFilter":[
                              
                           ],
                           "sessionTarget":"NONE",
                           "securelyRecorded":false
                        }
                     },
                     {
                        "key":"Body",
                        "value":{
                           "type":"STRING",
                           "expression":"",
                           "string":"{\"id\":9223372036854024377,\"petId\":0,\"quantity\":0,\"shipDate\":\"2022-04-20T22:08:11.977+0000\",\"status\":\"placed\",\"complete\":true}",
                           "number":"",
                           "boolean":"",
                           "repository":"",
                           "variableName":"",
                           "packageId":"",
                           "packageName":"",
                           "iteratorId":"",
                           "iteratorName":"",
                           "conditionalId":"",
                           "conditionalName":"",
                           "list":[
                              
                           ],
                           "dictionary":[
                              
                           ],
                           "exceptionName":"",
                           "thumbnailMetadataPath":"",
                           "screenshotMetadataPath":"",
                           "properties":[
                              
                           ],
                           "triggerName":"",
                           "formElementId":"",
                           "formElementType":"",
                           "formInstanceId":"",
                           "queueName":"",
                           "taskbotSelf":false,
                           "variableMapFilter":[
                              
                           ],
                           "sessionTarget":"NONE",
                           "securelyRecorded":false
                        }
                     }
                  ],
                  "exceptionName":"",
                  "thumbnailMetadataPath":"",
                  "screenshotMetadataPath":"",
                  "properties":[
                     
                  ],
                  "triggerName":"",
                  "formElementId":"",
                  "formElementType":"",
                  "formInstanceId":"",
                  "queueName":"",
                  "taskbotSelf":false,
                  "variableMapFilter":[
                     
                  ],
                  "sessionTarget":"NONE",
                  "securelyRecorded":false
               }
            }
         },
         "tenantUuid":"06e42523-b44a-49f4-82dc-b8d420896761",
         "automationPriority":"PRIORITY_MEDIUM",
         "callbackInfo":"",
         "runElevated":false,
         "botLabel":"",
         "currentBotName":"REST-Web-Service"
      }
   ]
}

回應參數


參數	類型	說明
偏移	整數	用於分頁的開始清單偏移值。
總計	整數	記錄總次數。
totalFilter	整數	套用篩選後的記錄次數。
清單	陣列	清單活動物件的陣列。
清單活動物件
ID	整數	特定活動的唯一 ID。
automationName	字串	自動化的名稱。
fileName	字串	機器人檔案名稱。
filePath	字串	機器人的檔案路徑。註: 由於 filePath 已過時，請使用獲取直系父母 API，端點： `GET http://{{ControlRoomURL}}/v2/repository/files/{fileid}/parents` 根據輸入檔案 ID 擷取檔案路徑
類型	字串	與此機器人相關的檔案類型。以下是類型的可能值： `TASK`：一般bot。 `RUN_NOW`：部署為可立即執行的機器人 `WLM_TASK`：工作生命週期管理。 `WORKFLOW`：這是 `WLM_TASK` 的一部分。 `WORKORDER`：這是 `WLM_TASK` 的一部分。 `AARI`：流程bot。
startDate	字串	此機器人開始的日期和時間。
endDate	字串	此機器人結束的日期和時間。
command	字串	機器人目前所在的命令。
status	字串	機器人的狀態。可能的值如下： `COMPLETED`：bot已成功完成執行。 `DEPLOYED`：自動登入成功，且已將bot部署至裝置。 `DEPLOY_FAILED`：無法將bot部署至裝置。例如，如果自動登入失敗。 `QUEUED`：要求的使用者或裝置正忙於執行其他執行作業。 `PENDING_EXECUTION`：已選取裝置，但尚未將bot部署至該裝置。 `RUNNING` 或 `UPDATE`：正在裝置上執行bot。 `RUN_FAILED`：bot在部署至裝置後失敗。 `RUN_PAUSED`：使用者已暫停bot。 `RUN_TIMED_OUT`：bot無法在特定期間內完成任務。 `UNKNOWN`：服務與裝置之間的連線已中斷。
progress	整數	機器人進度百分比。
totalLines	整數	機器人包含的命令列總數。
currentLine	整數	機器人目前正在處理的命令列。
timeTaken	整數	機器人完成作業所需的時間，以毫秒為單位。
progress	整數	機器人進度百分比。
automationId	整數	自動化的 ID。
userId	整數	使用者的 ID。
deviceId	整數	裝置的 ID。
currentLine	整數	機器人目前正在處理的命令列。
totalLines	整數	機器人包含的命令列總數。
fileId	整數	機器人檔案的唯一識別碼。
modifiedBy	整數	修改活動之使用者的 ID。
createdBy	整數	建立活動之使用者的 ID。
modifiedOn	字串	進行修改時的時間戳記。
createdOn	字串	建立活動的時間戳記。
deploymentId	字串	機器人的部署 ID。
queueName	字串	佇列的名稱。
queueId	字串	佇列的 ID。
usingRdp	布林值	顯示機器人是否使用遠端部署通訊協定的標記。
message	字串	傳回執行狀態詳細資料的錯誤訊息。
canManage	布林值	標記以顯示是否可管理機器人。
deviceName	字串	裝置的名稱。
userName	字串	執行機器人之使用者的使用者名稱。
tenantUuid	字串	租用戶的唯一 UUID。
automationPriority	字串	自動化優先順序。此值預設為 `PRIORITY_MEDIUM`。`automationPriority` 可能的值包括：`PRIORITY_MEDIUM`、 `PRIORITY_HIGH` 和 `PRIORITY_LOW`。
callbackInfo	字串	`callbackInfo` 提供回呼 API URL (例如 https://callbackserver.com/storeBotExecutionStatus) 和回呼伺服器的驗證權杖。部署bot後，Control Room 會將部署狀態和輸出變數值傳送至此回呼伺服器。註: 回呼伺服器必須接受 POST 呼叫，才能從 Control Room 接收bot執行資料和部署狀態。
runElevated	布林值	顯示是否使用較高權限部署機器人的標記。可能的值包括：`false`、`true`
botLabel	字串	機器人的標籤，可用來區分機器人的生產和測試等類別
currentBotName	字串	機器人的目前機器人名稱。它可能會在執行期間變更。
botOutVariables 物件
輸出	變化	包含所有輸出物件的資料結構。請參閱下方以瞭解更多詳細資料
type*	任何	`type` 可能的值包括：`STRING`、`NUMBER`、`BOOLEAN`、`FILE`、`ITERATOR`、`LIST`、`DICTIONARY`、`TABLE`、`VARIABLE`、`CONDITIONAL`、`WINDOW`、`TASKBOT`、`DATETIME`、`UIOBJECT`、`RECORD`、`EXCEPTION`、`CREDENTIAL`、`COORDINATE`、`IMAGE`、`REGION`、`PROPERTIES`、`TRIGGER`、`CONDITIONALGROUP`、`FORM`、`FORMELEMENT`、`HOTKEY` 和 `WORKITEM`。
*輸出的結構會因輸出而異。

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

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