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

Automation Anywhere Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

bots API をデプロイ

  • 更新済み: 2/01/2021
    • Automation 360 v.x
    • 管理
    • RPA Workspace

bots API をデプロイ

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

前提条件

注: Community EditionControl Room APIs を表示できますが、API 機能は制限されています。API のすべての機能にアクセスするには、Automation 360 のライセンス版が必要です。
次のリソースが割り当てられていることを確認します。
  • [マイ Bot の表示と実行] 機能権限
  • bots を含むフォルダーの [実行とスケジュール] 権限
  • Bot Runner のライセンスを付与されたユーザーへのアクセス。
  • デフォルト デバイスまたはデバイス プールへのアクセス
    注: Bot Runner ライセンスに関連付けられたユーザーが、アカウントに割り当てられたデフォルトのデバイスを保有している場合、bot はそのデバイスにデプロイされます。デフォルト デバイスが割り当てられていない場合、または別のデバイスを選択する場合、デバイス プールを指定する必要があります。

bot をデプロイして変数値を bot に渡すには、次の情報を API に指定します。

パラメーター 必須 タイプ 説明
fileId はい 数値 デプロイする bot の識別子。

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

runAsUserIds はい 数値 Control RoomUnattended Bot runner として登録されているユーザーの識別子。

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

poolIds いいえ 数値 少なくとも 1 つのアクティブなデバイスを持つデバイス プールの識別子。
注: Bot Runner ライセンスに関連付けられたユーザーが、アカウントに割り当てられたデフォルトのデバイスを保有している場合、bot はそのデバイスにデプロイされます。デフォルト デバイスが割り当てられていない場合、または別のデバイスを選択する場合、デバイス プールを指定する必要があります。

デバイス プール API の一覧表示

overrideDefaultDevice いいえ Boolean Bot Runner ユーザーがデフォルト デバイスに割り当てられていて、デバイス プールを指定する場合、このパラメーターを true に設定します。

デフォルト デバイスにデプロイする場合、このパラメーターを false に設定します。

botInput いいえ 異なる 入力変数名、値、データ型を指定します。
numOfRunAsUsersToUse いいえ 数値 runAsUserIds のリストから使用する Bot Runners の数を指定します。加重システム アルゴリズムは、キューされるタスクの数が最も少ない Bot Runners を選択します。
callbackInfo いいえ オブジェクト コールバック サーバーの URL と認証トークンを提供します。bot がデプロイされると、Control Room はデプロイのステータスと出力変数値をこのコールバック サーバーに送信します。

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
  2. POST メソッドとエンドポイント URL: <your_control_room_url>/v3/automations/deploy

    リクエスト本文:

    この例のリクエスト本文では、必要なパラメーターと入力変数の値を指定します。
    {
      "fileId": 14277,
      "runAsUserIds": [
        2538
      ],
      "botInput": {
        "sDocHello": {
          "type": "STRING",
          "string": "Hello world, go be great."
        }
      }
    }
    この例のリクエスト本文では、4 つの runAsUserIds と 2 つの numOfRunAsUsersToUse を指定します。重み付きアルゴリズムは、デプロイ リクエスト時にキューに入れられたタスク数が最も少ない 2 つの Bot Runners タスクを選択します。
    {
      "fileId": 14277,
      "runAsUserIds": [
        2538,
        4256,
        2213,
        789
      ],
       "poolIds": [
        27
      ],
      "numOfRunAsUsersToUse": 2
    }
    この例のリクエスト本文では、overrideDefaultDevicetrue に設定されているため、 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 Deploy API は deploymentId を含むレスポンスを返します。
    {
      "deploymentId": "14c2b6f8-c2a0-4a57-959d-ef413df0d179"
    }
    REST API は、HTTP レスポンス コードで各リクエストに応答します。 レスポンス コードについては、API レスポンス コード を参照してください。

次のステップ

このタスクを実行します: Bot の導入ステータスをリクエストする API

フィードバックを送る