Automation Anywhere

Automation Anywhere Automation 360

關閉內容

內容

開啟內容

計劃 bot 運行 API

  • 已更新:3/02/2021
    • Automation 360 v.x
    • 探索
    • RPA 工作區

計劃 bot 運行 API

安排在 bot 無人值守 Bot Runner 的情況下運行一次或重複運行。

先決條件

註: 您可以在中查看, Control Room APIs Community Edition但 API 功能受限。您需要授權 Automation 360 版本才能存取 API 的完整功能。
  • 使用 驗證 API 來產生 JSON Web Token 。
  • 確保分配了以下資源:
    • 檢視並執行我的機器人 程式功能權限
    • 包含的資料夾執行及排程權限 bots
    • Bot Runner 許可用戶的訪問
    • 訪問默認設備或設備池
      註: 如果與 Bot Runner 許可證關聯的用戶具有分配給其帳戶的默認設備,則 bot 會在該設備上部署。如果未指定默認設備,或者要選擇其他設備,則必須指定設備池。

要計劃, bot您需要向 API 提供以下信息:

參數 必填 類型 描述
fileId 數字 的標識符 bot按工作空間 API 列出文件和文件夾
RunAsUserIds 數字 在註冊 Control RoomUnattended bot runner 之使用者的識別碼列出可用的無人值守 Bot Runners API
status 字串 指示是創建活動計劃還是創建草稿計劃。輸入 活動草稿
泳池 不可以 數字 至少具有一個活動設備的設備池的標識符。
註: 如果與 Bot Runner 許可證關聯的用戶具有分配給其帳戶的默認設備,則 bot 會在該設備上部署。如果未指定默認設備,或者要選擇其他設備,則必須指定設備池。
列出設備池 API

程序

  1. 將驗證令牌添加到請求標頭。
  2. 使用 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"
    }
  3. 發送請求。
    回應本文:這兩個示例響應包括有關自動化的以下信息:
    • ID:標識自動化的數值。在 “更新自動” 或“刪除自動” API 中使用此參數。
    • zonedNextRunDateTimebot 下次計劃運行的日期和時間。
    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 檢索所有計劃自動化的詳細信息。
傳送意見反饋