Automation Anywhere ドキュメントを読んで確認する

Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

Bot をデプロイ

  • 更新済み: 2022/04/07
    • Automation 360 v.x
    • 最適化
    • RPA Workspace
    • API ドキュメント

Bot をデプロイ

Bot Runner ライセンスを持つユーザーとして、割り当てられたデバイスに Bot をデプロイします。また、変数は、デプロイされたときに Bot に渡すこともできます。

リクエスト

POST https://{{ControlRoomURL}}/v3/automations/deploy
Header: X-Authorization <<authentication token>>
認証 API を使用して JSON Web トークンを生成します。認証 API をご覧ください。
注: Bot のデプロイのリクエストは、入力フィールド無しでも可能です。入力を指定する場合、Bot がこれらのマッピングされた値を正常に受信することを確認します。その Bot 用の変数は入力としてマークされている必要があります。さらに、Bot の変数名は、リクエスト本文にマッピングされる値と一致しなければなりません。
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://callbackserver.com/storeBotExecutionStatus", 
    "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://callbackserver.com/storeBotExecutionStatus", 
    "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 Integer はい デプロイされる Bot のファイル ID。

ワークスペース API 別にファイルとフォルダーを一覧表示

automationName 文字列 いいえ デプロイされるオートメーションの名前。
runAsUserIds Integer はい Bot をデプロイする runAs ユーザー ID のリスト。Bot は、各 runAsUserIds の関連するデフォルト デバイス、またはデバイス プールからのデバイスの 1 つ (提供された場合) にデプロイされます。

利用可能な Unattended Bot Runner API のリスト

callbackInfo オブジェクト いいえ callbackInfo は、コールバック API の URL (例: https://callbackserver.com/storeBotExecutionStatus) とコールバック サーバーの認証トークンを提供します。Bot がデプロイされると、Control Room はデプロイのステータスと出力変数値をこのコールバック サーバーに送信します。
注: コールバック サーバーは、POST コールを受け入れて、Control Room からの Bot 実行データおよびデプロイ ステータスを受け取る必要があります。
poolIds Integer いいえ 個々の Runner ではなく、デバイス プールや Runner のプールに対して実行する場合のみ poolIds を定義します。少なくとも 1 つのアクティブなデバイスを持つデバイス プールの識別子。複数のプール ID を入力する場合は、API で利用可能なデバイスを確認する順番に値を入力してください。導入時に選択可能デバイスがない場合、このオートメーションはキューに入ります。
注: Bot Runner ライセンスに関連付けられたユーザーが、アカウントに割り当てられたデフォルトのデバイスを保有している場合、Bot はそのデバイスにデプロイされます。デフォルト デバイスが割り