閱讀及檢閱 Automation Anywhere 文件

Automation Anywhere Automation 360

關閉內容

內容

開啟內容

清單自動化排程 API

  • 已更新:2021/01/26

    清單自動化排程 API

    擷取您有權檢視之自動化排程的詳細資料。

    先決條件

    註: 您可以在中查看, Control Room APIs Community Edition但 API 功能受限。您需要授權 Automation 360 版本才能存取 API 的完整功能。
    • 使用 驗證 API 來產生 JSON Web Token 。
    • 您必須被指派一個角色、其中包含 「從我的資料夾」 權限中檢視和管理所有排定的活動。

    在此示例中,您將列出按下一個運行日期和時間排序的所有計劃自動化。

    程序

    1. 將驗證令牌添加到請求標頭。
    2. 使用 POST 方法和端點 URL :<control_room _url>/v1/schedule/automations/list
      要求本文:
      {
         "sort":[
            {
               "field":"zonedNextRunDateTime",
               "direction":"asc"
            }
         ]
      }
    3. 發送請求。
      回應本文:響應包括有關每個自動化的以下數據:
      • ID:標識自動化的數值。在 “更新自動” 或“刪除自動” API 中使用此參數。
      • Status(狀態):返回計劃的自動化 是活動 的還是非活動的。
      {
          "page": {
              "offset": 0,
              "total": 3,
              "totalFilter": 3
          },
          "list": [
              {
                  "id": "661",
                  "name": "eodReport_28.20.10.12.23.02.48",
                  "fileId": "6598",
                  "status": "ACTIVE",
                  "deviceIds": [],
                  "description": "",
                  "rdpEnabled": false,
                  "scheduleType": "DAILY",
                  "dailyRecurrence": {
                      "interval": 3
                  },
                  "timeZone": "America/Los_Angeles",
                  "startDate": "2020-10-12",
                  "endDate": "",
                  "startTime": "23:30",
                  "repeatEnabled": true,
                  "repeatOccurrence": {
                      "runEvery": "3",
                      "timeUnit": "HOURS",
                      "endTime": "23:59"
                  },
                  "zonedNextRunDateTime": "2021-01-14T07:30:00Z",
                  "createdBy": "251",
                  "createdOn": "2020-10-13T06:01:51.992433Z",
                  "updatedBy": "251",
                  "updatedOn": "2021-01-11T07:30:00.082057Z",
                  "tenantId": "1",
                  "fileName": "wlm_28",
                  "filePath": "Automation Anywhere\\Bots\\West Coast",
                  "runAsUserIds": [
                      "251"
                  ],
                  "botInput": {},
                  "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
                  "poolId": [
                      "23"
                  ],
                  "overrideDefaultDevice": false,
                  "runElevated": false
              },
              {
                  "id": "990",
                  "name": "accounts.20.12.16.10.51.59",
                  "fileId": "12501",
                  "status": "ACTIVE",
                  "deviceIds": [],
                  "description": "",
                  "rdpEnabled": false,
                  "scheduleType": "WEEKLY",
                  "weeklyRecurrence": {
                      "interval": 1,
                      "daysOfWeek": [
                          "TUE",
                          "THU",
                          "FRI"
                      ]
                  },
                  "timeZone": "Australia/Melbourne",
                  "startDate": "2021-01-16",
                  "endDate": "2021-12-24",
                  "startTime": "20:45",
                  "repeatEnabled": true,
                  "repeatOccurrence": {
                      "runEvery": "1",
                      "timeUnit": "HOURS",
                      "endTime": "23:59"
                  },
                  "zonedNextRunDateTime": "2021-01-19T09:45:00Z",
                  "createdBy": "1103",
                  "createdOn": "2021-01-11T18:59:31.182663Z",
                  "updatedBy": "1103",
                  "updatedOn": "2021-01-11T18:59:31.182669Z",
                  "tenantId": "1",
                  "fileName": "a_trigger",
                  "filePath": "Automation Anywhere\\Bots\\APAC",
                  "runAsUserIds": [
                      "80",
                      "36",
                      "1103"
                  ],
                  "botInput": {},
                  "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
                  "poolId": [
                      "7"
                  ],
                  "overrideDefaultDevice": false,
                  "runElevated": false
              },
              {
                  "id": "989",
                  "name": "UpdateInventory.20.12.16.10.40.48",
                  "fileId": "11201",
                  "status": "ACTIVE",
                  "deviceIds": [],
                  "description": "",
                  "rdpEnabled": false,
                  "scheduleType": "NONE",
                  "timeZone": "Asia/Calcutta",
                  "startDate": "2021-12-16",
                  "endDate": "",
                  "startTime": "15:00",
                  "repeatEnabled": false,
                  "zonedNextRunDateTime": "2021-12-16T09:30:00Z",
                  "createdBy": "1103",
                  "createdOn": "2021-01-11T18:57:18.932407Z",
                  "updatedBy": "1103",
                  "updatedOn": "2021-01-11T18:57:18.932422Z",
                  "tenantId": "1",
                  "fileName": "appsheet",
                  "filePath": "Automation Anywhere\\Bots\\spreadsheets",
                  "runAsUserIds": [
                      "480",
                      "80",
                      "472"
                  ],
                  "botInput": {},
                  "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
                  "poolId": [
                      "11"
                  ],
                  "overrideDefaultDevice": false,
                  "runElevated": false
              }
          ]
      }
      REST API 會以 HTTP 回應碼回應每個要求。有關響應代碼,請參閱 API 回應碼
    傳送意見反饋