REST Web サービス パッケージ
- 最終更新日2025/01/09
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 を読み取ることができます。 詳細については、「ファイルの代入アクション」を参照してください。
- バイナリ: 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 はプロセス メモリ内で暗号化されるため、 永続的に保存されることはなく、 自動化セッション外からはアクセスできません。
- 再利用: Cookiesは後続の REST 呼び出しに自動的に含まれるため、 手動でのクッキー処理が不要になり、 自動化の信頼性が向上します。
- 複数の Cookie の処理: この機能は、サーバーから返される複数の Cookie を シームレスに処理し、必要な認証資格情報がすべて含まれていることを 保証します。
- 破壊: キャプチャされた Cookie は、自動化セッションが 終了するかBotの実行が終了すると自動的に破棄され、 データのセキュリティとプライバシーが確保されます。
注: キャプチャされた Cookie は、 その 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 ミリ秒です。
-
出力変数: レスポンスの出力は
ディクショナリ変数です。 ディクショナリ変数はキーと値のペアです。 ヘッダー値を返すには、
応答ヘッダー名をキーとして使用し、応答本文を返すには、「Body」をキーとして
使用します。注: 応答キーと その値は辞書変数で使用でき、 REST API の応答ステータスを表示できます。API リソースの ヘッダー名のリストを取得するには、次の手順を実行します。
- ループを挿入 アクション の後に REST Web サービス アクション.
- ディクショナリ内の各キー イテレータを 選択します。
- 辞書変数 フィールドで REST Web サービス を保持する変数を選択し、 アクション 出力を選択します。
- 各キーの値を
$prompt-assignment$
に割り当てます。 - ファイルに記録を挿入 アクション.
- ヘッダー名のリストを保持するテキスト ファイルへのファイル パスを 指定します。
-
$prompt-assignment$
を ログに入力するテキスト フィールドに挿入します。 - 既存のファイルを上書きを選択します。 オプションを選択します。
- [保存] をクリックします。
Bot を実行すると、API リソースのヘッダー名が選択したファイルに出力されます。
値の安全な受け渡し
サポートされている次の Credential Vault、認証情報、属性を指定することにより、ロッカー から Web サービスに値を安全に渡すことができます
(アクションフィールドに)
- URI
- カスタム ヘッダー
- 本文:
application/x-www-form-urlencoded
コンテンツタイプの場合、 クリック パラメータを追加 して Credential Vault から値を選択します。その他のコンテンツタイプについては、 パラメーターとして資格情報を選択 オプションを選択して 選択をクリックします。
アクションのREST Web サービス パッケージ
プロキシ サポート
デバイスがプロキシで構成されている場合、この パッケージ からのすべてのアウトバウンド リクエストはプロキシ サーバー経由でルーティングされます。 「Bot エージェント とプロキシの設定されているデバイスの接続」を参照してください。