日程 bot 運行 API

排定bot在全自動 Bot Runner 上執行，可一次性執行，或是週期性執行。

先決條件

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

所有 API 調用都必須包含來自驗證 API （生成 JSON Web 令牌）或來自 OAuth 服務的不記名令牌。您不能在 API 中同時使用兩者。
確保為您分配了以下資源：
- 查看和運行我的機器人功能權限
- 包含的文件夾的運行和計劃bots
- 進入 Bot Runner 許可用戶
- 訪問默認設備或設備池
  註: 如果用戶與 Bot Runner 許可證有一個默認設備分配給他們的帳戶， bot 部署在該設備上。如果沒有分配默認設備，或者您想要選擇不同的設備，那麼您必須指定一個設備池。

安排一個 bot，您向 API 提供以下信息：


參數	必填	類型	說明
fileId	是	數字	的標識符 bot.通過工作區 API 列出文件和文件夾
runAsUserIds	是	數字	在您的網站上註冊的用戶的標識符 Control Room 作為無人值守的機器人跑步者。列表可用無人值守 Bot Runners 應用程序接口
status	是	字串	指示是創建活動計劃還是草稿計劃。輸入 `ACTIVE` 或 `DRAFT`。
poolIds	否	數字	具有至少一個活動設備的設備池的標識符。列出設備池 API
overrideDefaultDevice	否	布林值	如果 Bot Runner 使用者已指派至預設裝置，而您想要指定裝置集區，請將此參數設定為 `true`。若是部署至預設裝置，請將此參數設定為 `false`。

程序

將身份驗證令牌或承載令牌添加到請求標頭。您不能在同一 API 中同時使用兩者。

使用 POST 方法和端點 URL：<control_room_url>/v1/schedule/automations。

請求正文：

此示例請求正文包含安排 bot 運行一次。

{
   "name":"UpdateInventory.20.12.16.10.40.48",
   "fileId":14277,
   "poolIds":[
      "27"
   ],
   "timeZone":"Asia/Calcutta",
   "runAsUserIds":[
      "472",
      "480",
      "80"
   ],
   "startDate":"2020-12-16",
   "startTime":"15:00",
   "scheduleType":"NONE",
   "status":"ACTIVE"
   }

此示例請求正文包含安排 bot 定期運行。

{
   "name":"UpdateInventory.20.12.16.10.40.48",
   "fileId":14277,
   "poolIds":[
      "27"
   ],
   "timeZone":"Australia/Melbourne",
   "runAsUserIds":[
      "1103",
      "36",
      "80"
   ],
   "startDate":"2020-12-16",
   "repeatOccurrence":{
      "endTime":"23:59",
      "runEvery":"1",
      "timeUnit":"HOURS"
   },
   "repeatEnabled":true,
   "endDate":"2020-12-24",
   "startTime":"20:45",
   "weeklyRecurrence":{
      "interval":"1",
      "daysOfWeek":[
         "TUE",
         "THU",
         "FRI"
      ]
   },
   "scheduleType":"WEEKLY",
   "status":"ACTIVE"
}

傳送要求。

響應體：兩個示例響應包括以下有關自動化的信息：

id：標識自動化的數值。更新自動化或刪除自動化 API中使用此參數。
zonedNextRunDateTime：下次運行的日期和時間 bot 計劃運行。

這是一個示例響應 bot 計劃運行一次。

{
    "id": "989",
    "name": "UpdateInventory.20.12.16.10.40.48",
    "fileId": 14277,
    "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\\appsheet",
    "runAsUserIds": [
        "480",
        "80",
        "472"
    ],
    "botInput": {},
    "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
    "poolId": [
        "11"
    ],
    "overrideDefaultDevice": false,
    "runElevated": false
}

這是一個示例響應 bot 計劃定期運行。

{
    "id": "990",
    "name": "UpdateInventory.20.12.16.10.40.48",
    "fileId": 14277,
    "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\\a_trigger",
    "runAsUserIds": [
        "80",
        "36",
        "1103"
    ],
    "botInput": {},
    "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
    "poolId": [
        "7"
    ],
    "overrideDefaultDevice": false,
    "runElevated": false
}

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

後續步驟

使用列出自動化計劃 API 檢索有關所有預定自動化的詳細信息。