閱讀及檢閱 Automation Anywhere 文件

Automation 360

關閉內容

內容

開啟內容

部署 bots API

  • 已更新:2021/03/08

    部署 bots API

    作爲具有 Bot Runner 許可證的用戶,部署 bots 到指派的設備上。您也可以在 bots 變數部署時將其傳遞至。

    先決條件

    註: 您可以查看 Control Room APIs 在裡面 Community Edition,但 API 功能有限。你需要有執照的 Automation 360 用於訪問 API 全部功能的版本。
    確保為您分配了以下資源:
    • 查看和運行我的機器人 功能權限
    • 包含文件夾的 運行和計劃bots
    • 進入 Bot Runner 許可用戶
    • 訪問默認設備或設備池
      註: 如果用戶與 Bot Runner 許可證有一個默認設備分配給他們的帳戶, bot 部署在該設備上。如果未分配默認設備,或者您想選擇不同的設備,則必須指定設備池。

    要部署 bot 並將變量值傳遞到 bot,您需要向 API 提供以下信息:

    參數 必填 類型 描述
    fileId 數字 bot 要部署的的的標識符。

    按工作區 API 列出文件和文件夾

    RunAsUserIds 數字 在註冊 Control RoomUnattended bot runner 之使用者的識別碼

    列出可用的無人值守 Bot Runners API

    泳池 不可以 數字 至少具有一個活動設備的設備池的標識符。如果輸入多個池 ID ,請按希望 API 檢查可用設備的順序輸入值。如果在部署時沒有可用的設備,則自動化會排隊。
    註: 如果用戶與 Bot Runner 許可證有一個默認設備分配給他們的帳戶, bot 部署在該設備上。如果未分配默認設備,或者您想選擇不同的設備,則必須指定設備池。

    列出設備池 API

    覆蓋 DefaultDevice 不可以 布林值 如果 Bot Runner 將用戶分配給默認設備,並且要指定設備池,請將此參數設置爲 true

    如果部署到默認設備,請將此參數設置爲 false

    殭屍輸入 不可以 變化 指定輸入變量名稱、值和數據類型。
    NumOfRunAsUsersToUse 不可以 數字 指定 Bot Runners 從 runAsUserIds 列表中使用的數量。加權系統算法選擇 Bot Runners 隊列任務數量最少的。
    CallbackInfo 不可以 物件 爲回調服務器提供 URL 和驗證令牌。 bot 部署後, Control Room 會將部署狀態和輸出變量值發送到此回調服務器。

    程序

    1. 將身份驗證令牌添加到請求標頭。
    2. 使用 POST 方法和端點 URL: <your _control_room _url>/v3/automations/deploy

      請求主體

      此示例 request 主體指定了所需的參數以及輸入變量的值。
      {
        "fileId": 14277,
        "runAsUserIds": [
          2538
        ],
        "botInput": {
          "sDocHello": {
            "type": "STRING",
            "string": "Hello world, go be great."
          }
        }
      }
      此示例請求主體指定了四 個 runAsUserIds 和兩 個 numOfRunAsUsersToUse。加權算法選擇 Bot Runners 在部署請求時排隊的任務數最少的兩個任務。
      {
        "fileId": 14277,
        "runAsUserIds": [
          2538,
          4256,
          2213,
          789
        ],
         "poolIds": [
          27
        ],
        "numOfRunAsUsersToUse": 2
      }
      此示例請求主體包括 將 overrideDefaultDevice 設置爲 true,因此 bot 將部署到設備池而不是 Run-as 用戶的默認設備。此示例還包含用於指定回調服務器 URL 和提供授權的語法。
      {
        "fileId": 14277,
        "runAsUserIds": [
          245
        ],
         "poolIds": [
          27
        ],
        "overrideDefaultDevice": true,
        "callbackInfo": {
          "url": "https://callbackserver.com/storeBotExecutionStatus",
          "headers": {
            "X-Authorization": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiI0Ii"
          }
        }
      }
    3. 發送請求。

      響應主體

      如果成功, Bot 部署 API 將返回具有 deploymentId的響應。
      {
        "deploymentId": "14c2b6f8-c2a0-4a57-959d-ef413df0d179"
      }
      REST API 使用 HTTP 響應代碼響應每個請求。有關響應代碼,請參閱 API 響應代碼.

    後續步驟

    執行此任務:活動清單

    傳送意見反饋