Automation Anywhere

Automation Anywhere

關閉內容

內容

開啟內容

用於機器人部署的Enterprise 控制室 API

  • 已更新:5/10/2019
    • 11.3.x
    • 探索
    • Enterprise
    • API 文件

用於機器人部署的Enterprise 控制室 API

使用Enterprise 控制室機器人部署 API,從外部系統或第三方應用程式觸發機器人。

若要將機器人部署到自動化環境中,使用者目前必須登入Enterprise 控制室、選取機器人機器人執行器,然後「執行/排程」任務。

然而,隨著自動化情境的規模擴增,從外部第三方應用程式部署/觸發機器人的需求也會不斷增加。

為了滿足此業務需求,Automation Anywhere 發佈了應用程式開發介面 (API),使用這些 API 時,就可以從外部系統觸發機器人

當第三方/外部應用程式指定的事件開始時,Enterprise 控制室使用者可以使用這些 API 將機器人 (任務) 部署到機器人執行器

註: 您無法從Enterprise 控制室部署半自動機器人。只有全自動機器人可從Enterprise 控制室部署。

Enterprise 控制室 API 的主要功能和商業優勢

  • 您可使用 Automation Anywhere API 從外部第三方系統部署機器人
  • API 的輸入和輸出為 JSON 型式 (產業標準資料交換格式)。
  • 您可使用指令碼和 Automation Anywhere API 的組合從外部應用程式/工作流程協調機器人部署。
註: 只有在使用驗證 API 驗證系統/使用者後,才能叫用機器人部署 API

此外,使用者在要部署機器人機器人執行器上也必須擁有「執行我的機器人」的權限及該機器人執行器的權限。

部署 API

部署 API 是用來將機器人部署到機器人執行器

API:<Enterprise 控制室 URL>/v1/schedule/automations/deploy

例如,如果Enterprise 控制室 URL 為 https://www.ultron.com:81,則機器人部署 API 將會是 https://www.ultron.com:81/v1/schedule/automations/deploy

使用者可以傳遞三個參數當做 JSON 字串。

  1. 機器人名稱含相對路徑 – 此為必要項目。
  2. JSON 格式的機器人執行器和使用者清單 – 此為必要項目。
  3. 使用 RDP 式做法 – 此為選擇性項目,預設設為 false

部署情境和對應的 JSON 字串:

  1. 例如,機器人的名稱為 Accounts機器人.atmx,而且機器人位在 ‘My Tasks’ 底下
  2. 機器人要部署到 3 部電腦上
    • 第一部電腦的主機名稱為 BR-1,且擁有 U-1 使用者
    • 第二部電腦的主機名稱為 BR-2,且擁有 U-2 使用者
    • 第三部電腦的主機名稱為 BR-3,且擁有 U-3 使用者。
  3. 上述情境的 JSON 字串如下:

    {

    "taskRelativePath":"My Tasks\\Accounts機器人.atmx", "機器人執行器s":

    [

    {

    "client":"BR-1", "user":"U-1"

    },

    {

    "client":"BR-2", "user":"U-2"

    },

    {

    "client":"BR-3", "user":"U-3"

    }

    ]

    }

機器人部署 API 回應碼

Http(s) 狀態碼 回應 - 說明
200 自動化建立成功。
400 錯誤的要求
401 需要驗證
403 未經授權的存取
409 發生衝突
500 內部伺服器錯誤
傳送意見反饋