REST Web サービス パッケージ

アクション REST Web サービスのパッケージをメソッド (DELETE、GET、PATCH、POST、または PUT) として使用し、API へリクエストを送信し API からレスポンスを受信します。

REST Web サービス アクションの操作

REST リクエストを送信してレスポンスを受信するには、次の情報を指定します。 すべてのメソッドで必ずしもすべてのパラメーターが必要なわけではありません。
  • URI を入力: API リソースの一意のアドレス。
  • プロキシ構成: プロキシを設定するには、[プロキシ構成] から システム または カスタム タブを選択します。
    オプション 説明
    システム

    システム プロキシは、Bot が動作している Bot ランナー マシンに設定されているプロキシです。

    このオプションが選択されている場合、Bot エージェントはシステム プロキシを使用します。
    カスタム

    このオプションは、アクション のREST Web サービス内でカスタム プロキシを設定することができます。 たとえば、REST API をシステム プロキシ以外の別のプロキシでルーティングする必要がある場合、カスタム オプションを選択し、REST アクション内にプロキシの詳細を指定することが可能です。

    以下の詳細を指定します。

    • ホスト: プロキシのホスト名または IP アドレス
    • ポート: プロキシのポート番号
    • ユーザー名 (任意): プロキシ認証に使用するユーザー名
    • パスワード (任意): プロキシ認証に使用するパスワード
      注: 設定するプロキシが認証プロキシである場合、ユーザー名 と パスワード のフィールドに資格情報を入力する必要があります。
    ホスト、ポート、ユーザー名、および パスワード の各フィールドの場合、資格情報、変数、または 安全でない文字列 タブから選択します。
    • 資格情報: 資格情報コンテナーで利用可能な値を使用します。
    • 変数: ユーザー定義変数に資格情報値を保存する変数を使用します。
    • 安全でない文字列: 使用する値を手動で指定します。
  • 認証モード: 3 つの認証モードがサポートされています。
    • 認証なし: サーバーへのアクセスに認証を必要としないエンドポイントにアクセスするには、このオプションを使用します。
    • Control Room ユーザー トークン: REST Web サービス アクションは、Control Roomへのログイン時に生成されたトークンを使用してエンドポイントにアクセスします。
    • 基本: [基本] は、ユーザーを認証する最も簡単な方法です。 このオプションを選択した場合は、ユーザー名とパスワードを入力します。 この手法では、入力されたユーザー名およびパスワードを base64 でエンコードした「Authorization」というヘッダーを使用します。
    • ログイン済み AD ユーザー: 関連する API にアクセスする権限を与えられた Active Directory (AD) ユーザーは、AD を介して認証されます。 リクエストに資格情報は必要ありません。
    • Windows NT LAN Manager (NTLM) 認証 (AD ユーザー): 暗号化された資格情報やプレーン テキストとしてユーザー名とパスワードをクライアントが提供できるチャレンジ/レスポンス認証方法。 Automation Anywhere Credential Vault に保存されている資格情報を使用することが推奨されます。
    • OAuth2 - Control Room でマネージ: OAuth と Control Room を統合すると、サードパーティ プロバイダーの認証に使用するトークンを一元管理し、安全に保管できます。 Control Room で OAuth 接続を使用するには、Web サービスを構成し、認証の詳細 (クライアント ID、クライアント シークレット、認証 URL など) をメモしておく必要があります。 詳細については、OAuth で Control Room 接続を構成する を参照してください

      次の動画では、OAuthで REST Web サービス 接続を使用する方法を示します。

  • ヘッダー: すべてのメソッドがヘッダーを必要とするわけではありません。 ヘッダーは、リクエストに関連付けられたメタデータを表します。
  • コンテンツタイプ: コンテンツ タイプを含むヘッダーは、クライアントとサーバー間のコンテンツ ネゴシエーションを定義します。REST Web サービス アクションは、次のコンテンツ タイプをサポートします。
    • application/x-www-form-urlencoded: URL のパラメーターをエンコードします。
    • JSON (application/json): JSON 要求本文を入力します。
    • XML (application/xml): XML 要求本文を入力します。
    • テキスト (text/plain)
    • XML (text/xml)
    • HTML (text/html)
    • マルチパート/フォームデータ
      • ほとんどの場合、ファイルをサーバーにアップロードするためにバイナリ データを送信します。 これは、1 回のリクエストで複数の部分を送信する場合に使用されます。通常は、テキスト データ (フォーム フィールドなど) やファイル アップロードなどが含まれます。 FileStream 変数を使用することもできます。 詳細については、以下をご覧ください。
      • FileStream: FileStream は、変数に割り当てた後で読み取ることができます。 たとえば、OneDrive の場所にある変数に割り当てられた FileStream を読み取ることができます。 詳細については、「ファイルの代入アクション」を参照してください。
        REST Web サービス FileStream
    • バイナリ: Binary を使用して、画像、ビデオ、音声ファイルなどの生ファイルを送信します。 バイナリを選択すると、バイナリファイル（変数として、Control Roomファイルまたはデスクトップファイル）をアップロードできるようになります。
    • カスタム
      カスタム: 標準コンテンツ タイプに該当しないカスタム コンテンツを追加します。 たとえば、v.11.x から Automation 360 に移行する場合、application/vnd.whispir.message-v1+json は標準コンテンツ タイプのいずれにも該当しません。
  • 置換を追加: REST 要求本文に変数を入力できます。 変数はデータのシンボリック表現であり、必要な場合は、手動で入力しなくても値にアクセスできます。 たとえば、次の REST 本文の要求について考えてみましょう。
    {
   "name":"{{name}}",
   "email":"{{email}}",
   "status":"Active"
}
    上記の要求本文では、[置換を追加] をクリックして必要な値を追加することで、二重カッコで囲まれた変数を置換できます。
  • 詳細オプション:
    • 失敗応答をキャプチャ: [成功/OK] のレスポンスを除く失敗レスポンスをキャプチャするには、このチェック ボックスをオンにします。 失敗レスポンスの詳細は、レスポンスの本文にキャプチャされます。
    • https を使用するときは、安全でない接続を許可します: https を使用するときに安全でない接続を許可する場合は、チェック ボックスをオンにします。
    • Cookie を受け入れる: サーバーのレスポンスからセッション Cookie を自動的にキャプチャするには、このチェック ボックスをオンにします。
      • キャプチャ: この機能を有効にすると、サーバーのレスポンスに含まれるセッション Cookie をキャプチャします。
      • 安全な保管: キャプチャされた Cookie は、プロセス メモリ内で暗号化され、永久に保存されることはなく、オートメーション セッション外ではアクセスできなくなります。
      • 再利用: Cookie は自動的に後続の REST 呼び出しに含まれるため、手作業による Cookie 処理が不要になり、オートメーションの信頼性が向上します。
      • 複数の Cookie の処理: この機能は、サーバーから返される複数の Cookie をシームレスに処理し、必要な認証情報がすべて含まれていることを保証します。
      • 破壊: キャプチャされた Cookie は、オートメーション セッションの終了時または Bot の実行終了時に自動的に破棄され、データのセキュリティとプライバシーが確保されます。
      注: キャプチャされた Cookie は、発行元のドメインに固有のものであり、異なるドメインに対して行われるその後の REST 呼び出しに自動的に使用されることはありません。 これは、domainA.com からキャプチャされた Cookie は、domainB.com へのリクエストには利用されないことを意味します。
    • ファイルをダウンロード: (Get メソッドのみ利用可 ファイルを特定の場所にダウンロードするには、このチェック ボックスを選択します。 URIはファイルを返す/ダウンロードする必要があります。 希望するフォルダパスと拡張子付きのファイル名を入力します。 正しいファイル拡張子を使用していることを確認してください。 次に例を示します。 C:/Users/Downloads/image01.jpg
      ヒント: 同名のファイルが既にフォルダーに存在する場合は、ファイルを上書きする オプションを選択して、保存するファイルの同名のファイルを上書きします。
      エラー処理:
      無効な URI:
      提供された URI が正しくない場合は、エラー メッセージが表示されます。
      ファイルが見つかりません:
      指定された場所にファイルが存在しないため、APIの応答が空の場合、エラーメッセージが表示されます。
      権限が不足しています:
      ダウンロード先に対する書き込み権限がない場合、エラーメッセージが表示されます。
      ファイル拡張子の不一致:
      ファイル拡張子が期待されるタイプと一致しない場合、エラーメッセージが表示されます。
  • アクションの完了を待機: REST リクエストを送信してレスポンスを受信するまでのタイムアウト値を設定できます。 POST、PUT、DELETE、PATCH、GET などの アクション を実行する場合、[アクションの完了を待機] フィールドで待機時間 (ミリ秒単位) を指定できます。 デフォルトでは、待機時間は 60,000 ミリ秒です。
  • SSL/TLSの設定: このオプションを使用して、REST API呼び出し中に追加の認証を提供するために、パスワードの有無にかかわらず証明書ファイルをアップロードします。

    SSL/TLS 構成 は、API URI とクライアント間の通信を暗号化し、認証し、保護するために相互 TLS (mTLS) プロトコルを使用します。mTLS は、両方のエンティティが証明書を交換してお互いを認証することを要求します。 両方のエンティティが交換された証明書を正常に認証した場合にのみ、データ送信が行われます。

    REST Web サービスはWindowsマシン用の.p12タイプの証明書と、非Windowsマシン用の.pfxフォーマットをサポートしています。

    • キーストア ファイル パス (任意): [変数]、[Control Room ファイル]、または [デスクトップ ファイル] オプションを使用して証明書ファイルをアップロードします。
    • キーストア パスワード (任意): 証明書がパスワードで保護されている場合、Credential、Variable、またはInsecure stringオプションを使用して証明書パスワードを認証できます。 Credential ロッカーにパスワードを安全に保存する方法についての詳細は、Credential Vault の資格情報と ロッカー を参照してください。
  • 出力変数: レスポンスの出力はディクショナリ変数にキャプチャされます。 ディクショナリ変数はキーと値のペアです。 レスポンス ヘッダー名をキーとして使用するとヘッダー値が返されます。「本文」をキーとして使用すると、レスポンス本文が返されます。
    注: REST API のレスポンス ステータスを表示するために、ディクショナリ変数においてレスポンス キーとその値を使用できます。
    API リソースのヘッダー名のリストを取得するには、次の手順を実行します。
    1. ループ アクションの後に REST Web サービス アクションを挿入します。
    2. [ディクショナリ内の各キー] 反復子を選択します。
    3. [ディクショナリ変数] フィールドで、REST Web サービス アクション出力を保持する変数を選択します。
    4. 各キーの値を $prompt-assignment$ に割り当てます。
    5. [ファイルに記録 アクション] を挿入します。
    6. ヘッダー名のリストを保持するテキスト ファイルへのファイル パスを指定します。
    7. [テキストをログへ入力] フィールドに $prompt-assignment$ を挿入します。
    8. [既存のファイルを上書き] オプションを選択します。
    9. [保存] をクリックします。

      Bot を実行すると、API リソースから選択したファイルにヘッダー名が印刷されます。

値の安全な受け渡し

Credential Vault から Web サービスに値を安全に渡すには、サポートされている次のロッカー フィールドにアクション、資格情報、および属性を指定します。
  • URI
  • カスタム ヘッダー
  • 本文: application/x-www-form-urlencoded コンテンツ タイプの場合は、[パラメーターを追加] をクリックして Credential Vault から値を選択します。

    他のすべてのコンテンツ タイプでは、[資格情報をパラメーターとして選択] オプションを選択して [選択] をクリックします。

アクション REST Web サービスのパッケージ

プロキシ サポート

デバイスがプロキシで構成されている場合、この パッケージ からのすべてのアウトバウンド リクエストはプロキシ サーバー経由でルーティングされます。 Bot エージェント とプロキシの設定されているデバイスの接続 を参照してください。