閱讀及檢閱 Automation Anywhere 文件

Automation 360

關閉內容

內容

開啟內容

機器人部署 - V3

  • 已更新:2022/09/22
    • Automation 360 v.x
    • 最佳化
    • RPA 工作區
    • API 文件

機器人部署 - V3

身為擁有 Bot Runner 授權的使用者,請在指派的裝置上部署bots。您也可以在部署機器人時傳遞變數至bots

要求

POST https://{{ControlRoomURL}}/v3/automations/deploy
Header: X-Authorization <<authentication token>>
所有 API 調用都必須在請求標頭中包含身份驗證令牌。使用 身份驗證 API 生成 JSON Web 令牌。 看 驗證 API.
註: 無需任何輸入欄位即可提出機器人部署要求。如果您指定輸入,請確定機器人成功接收這些對應的值,適用於該機器人的變數必須標示為輸入。此外,機器人中的變數名稱必須符合要求本文中對應的值。
具有 LIST 輸入的要求本文
{
  "fileId": 86, 
  "runAsUserIds": [
    3 
  ],
  "poolIds": [],
  "overrideDefaultDevice": false,
  "callbackInfo": {
    "url": "https://callbackserver.com/storeBotExecutionStatus", 
    "headers": {
      "X-Authorization": "{{token}}" 
    }
  },
  "botInput": { 
    "iTestList": {
      "type": "LIST", //Type can be [ STRING, NUMBER, BOOLEAN, LIST, DICTIONARY, DATETIME ]
     "list": [
        { "type":"STRING",
         "string": "TestValues1" 
    },
     { "type":"STRING",
         "string": "TestValues2" 
    }
     ] //key must match type, in this case string
    }
  }
}
具有 STRING 輸入的要求本文
{
  "fileId": 87,
  "runAsUserIds": [
    3 
  ],
  "poolIds": [],
  "overrideDefaultDevice": false,
  "callbackInfo": {
    "url": "https://eogp1yk2w1o3ec2.m.pipedream.net", 
    "headers": {
      "X-Authorization": "{{token}}" 
    }
  },
  "botInput": { 
    "sInput1": {
      "type": "STRING", 
      "string": "Test Values1" 
    },
    "sInput2": {
      "type": "STRING",
      "string": "Test Values2"
    }
  }
}
具有 NUMBER 輸入的要求本文
{
  "fileId": 87,
  "runAsUserIds": [
    3 
  ],
  "poolIds": [],
  "overrideDefaultDevice": false,
  "callbackInfo": {
    "url": "https://eogp1yk2w1o3ec2.m.pipedream.net", 
    "headers": {
      "X-Authorization": "{{token}}" 
    }
  },
  "botInput": { 
    "sInput1": {
      "type": "NUMBER", 
      "integer": 123
    },
    "sInput2": {
      "type": "NUMBER",
      "integer": 345
    }
  }
}
具有 DICTIONARY 輸入的要求本文
{
  "fileId": 86, 
  "runAsUserIds": [
    3 
  ],
  "botInput": { 
    "iTestList": {
      "type": "DICTIONARY", //Type can be [ STRING, NUMBER, BOOLEAN, LIST, DICTIONARY, DATETIME ]
     "dictionary": [
         {
            "key":"key1",
            "value":{
               "type":"STRING",
               "string":"value1"
            }
         },
         {
            "key":"key2",
            "value":{
               "type":"STRING",
               "string":"value2"
            }
         }
      ] //key must match type, in this case string
    }
  }
}
具有 DATE TIME 輸入的要求本文
{
  "fileId": 87,
  "runAsUserIds": [
    3 
  ],
  "botInput": { 
    "dt_input1": {
      "type": "DATETIME", 
      "string": "2022-04-07T00:15:00-06:00[USA/New York]" 
    },
    "dt_input2": {
      "type": "DATETIME",
      "string": "2022-04-07T00:15:05-06:00[USA/New York]"
    }
  }
}

要求參數

參數 類型 必填 說明
fileId 整數 要部署的bot檔案 ID。

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

automationName 字串 要部署的自動化名稱。
runAsUserIds 整數 要部署機器人的 runAs 使用者 ID 清單。若有提供,則會針對每個 runAsUserIds 將機器人部署到相關的預設裝置上,或部署到來自裝置集區的其中一個裝置上。

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

callbackInfo 字串 callbackInfo 提供回呼 API URL (例如 https://callbackserver.com/storeBotExecutionStatus) 和回呼伺服器的驗證權杖。部署bot後,Control Room 會將部署狀態和輸出變數值傳送至此回呼伺服器。例如:要測試回調,您可以在 https://pipedream.com/ 並使用端點(類似於 https://eogp1yk2w1o3ec2.m.pipedream.net) 接收狀態和輸出變量值。
註: 回呼伺服器必須接受 POST 呼叫,才能從 Control Room 接收bot執行資料和部署狀態。
poolIds 整數 只有在您針對裝置集區或執行器的集區 (而非個別執行器) 執行 poolIds 時,才可定義 poolIds。至少有一個作用中裝置的裝置集區識別碼。如果您輸入多個集區 ID,請依您希望 API 檢查可用裝置的順序來輸入值。若在部署時都