HTTP 要求

UiPath.Web.Activities.Http.NetHttpClient

重要: このアクティビティは、2.0.0-preview および 2.3.0 GA 以降の Web API パッケージ バージョンで利用できます。レガシ エクスペリエンスの場合は、2.0.0-preview より前の Web API バージョンに含まれていた以前の [HTTP 要求 (レガシ)] アクティビティを使用します。

説明

WebAPI 2.0.0-preview の [HTTP 要求] アクティビティを使用すると、Web サーバーまたは API への要求を自動化および簡素化できます。[HTTP 要求] アクティビティでは、以下のタスクを実行できます。

• システム間でデータを安全に送受信します。
• フォームを使用してファイルとデータをアップロードします。
• 問題が発生した場合は要求をリトライし、エラーを適切に処理します。
• SSL を使用して安全に接続し、データを保護します。
• Cookie とプロキシを自動的に管理して、セッションとネットワークの制限を処理します。

プロジェクトの対応 OS

Windows | クロスプラットフォーム

Windows、クロスプラットフォームでの設定

アクティビティの本体のプロパティ
要求メソッド *	HTTP 要求がサーバーと対話する方法を選択します。 GET - データを変更せずに取得します。 POST - データをサーバーに送信します。通常はリソースを作成または更新するために使用されます。 PUT - 既存のリソースを更新します。 DELETE - 指定したリソースをサーバーから削除します。 HEAD - GET に似ていますが、本文のコンテンツなしでヘッダーのみを取得します。 OPTIONS - サーバーで使用可能な通信オプションに関する情報を提供します。 PATCH - 既存のリソースを部分的に更新します。 TRACE - 診断目的で使用され、受信した要求をクライアントにエコーバックします。
要求 URL *	要求を送信するサーバーの Web アドレスを指定します。たとえば、https://store.example.com/searchのようになります。
パラメーター	サーバー固有の詳細情報をキーと値のペアとして要求に追加します。たとえば、「query: "laptop"」、「sortBy: "price"」のようになります。
ヘッダー	サーバー固有の指示または認証の詳細をキーと値のペアとして追加します。たとえば、「Authorization: "Bearer <your_access_token>"」、「Accept: "application/json"」のようになります。
要求本文の種類 *	サーバーに送信するコンテンツの種類を選択します。 None - データを送信しません。通常はメソッドを取得するために使用されます。 Text - データをプレーン テキストで送信します。通常は POST メソッドと PUT メソッドで使用されます。このオプションを選択すると、次のフィールドが表示されます。 テキストのコンテンツ タイプ - HTTP 要求で送信する以下のテキストの形式を選択して、サーバーがその解釈方法を認識できるようにします。 text/plain - 通常のプレーン テキスト。 text/html - HTML 形式のテキスト。 text/css - CSS 形式のテキスト。 text/csv - CSV 形式の構造化データ。 text/xml - 人間が読むための XML 形式のテキスト。 application/xml - アプリケーションが処理するための XML 形式のテキスト。 application/json - JSON 形式のテキスト。 テキスト - 要求で送信する実際のテキストまたはデータを入力します。 テキストのエンコード - テキスト ペイロードのエンコード形式 (Unicode、ASCII、ISO など) を選択します。これにより、受信サーバーはテキスト ペイロードを正確に読み取ることができます。 フォームを URL エンコード - 単純なキーと値のペアとして書式設定されたデータを送信します。このオプションを選択すると、次のフィールドが表示されます。 URL エンコードされたフォーム データ - キーと値のペアを指定します。たとえば、「searchQuery: "Smartphone"」、「brand: "XYZ"」、「inStock: "true"」のようにします。 マルチパート フォーム データ - ファイルまたは複雑なデータを送信します。要求で異なるデータ型を組み合わせる必要がある場合に使用します。このオプションを選択すると、次のフィールドが表示されます。 リソース ファイル - プロジェクト内に IResource オブジェクトとして保存されているファイルの名前を指定します。 ローカル ファイル - デバイス上にあるファイルへのパスを指定します。たとえば、"C:/Images/product-photo.jpg"のようになります。 フォーム データ パート - 以下の FormDataPart オブジェクトのコレクションを 指定します。 TextFormDataPart - JSON やプレーン テキストなどの文字列ペイロードの場合。 BinaryFormDataPart - 生のバイト配列の場合。 FileFormDataPart - 特定のパスに基づくファイル ストリームの場合。 たとえば、式エディターを使用した FormDataPart コレクションは次のようになります。 #VB New List(Of FormDataPart) From { New TextFormDataPart("{""jsonKey"":""jsonValue""}", "textPart", Encoding.UTF8, "application/json"), New BinaryFormDataPart(Encoding.UTF8.GetBytes("binaryContent"), "binaryPart", "application/octet-stream"), New FileFormDataPart("C:/Work/testfile.txt", "filePart", "text/plain") } 各 FormDataPart 型にはいくつかのコンストラクターが用意されており、一般的に使用される既定値を利用できます。 このアクティビティは、各 FileFormDataPart に適切な Content-Type ヘッダーを自動的に割り当てます。このヘッダーは手動で上書きできます。ファイル リストの場合、自動的に割り当てられたヘッダーを上書きすることはできません。リソース ファイル リストの場合、アクティビティは利用可能な MIME タイプを使用します。 URL エンコードされたフォーム データ - 単純なキーと値のペアを指定します。 バイナリ - 生データを送信します。このオプションを選択すると、次のフィールドが表示されます。 バイナリ ペイロード - 画像、ビデオ、大きなファイル、ストリーミング データなどの生データ ペイロードを指定します。たとえば、画像をバイナリで送信する場合は次のようになります。 File.ReadAllBytes("C:/Images/product-image.jpg") ストリーム - 大きなファイル (音声やビデオ) のアップロードなど、データを一度にメモリに完全に読み込むことができない場合に、継続的なデータを送信します。このオプションを選択すると、次のフィールドが表示されます。 ローカル ファイル - 大きなファイルのパスを指定します。たとえば、次のようになります。 File.OpenRead("C:/Videos/large-video.mp4") このアクティビティは、アップロードされたファイルに適切な Content-Type ヘッダーを自動的に割り当てます。このヘッダーは手動で上書きできます。

プロパティ パネル
[cURL のインポート] と設計時のテスト このセクションでは、cURL のコード スニペットを使用してアクティビティを設定し、要求の設計時のテストを実行するのに役立ちます。	[cURL コマンド] のテキスト - 設計時の複数行テキスト フィールドです。完全な cURL コマンドを貼り付けることができます。`cm スタイルと bash スタイルの両方がサポートされます。 cURL の [インポート] ボタン - 現在 [cURL コマンド] に入力されているテキスト (メソッド、URL、ヘッダー、本文、認証、ファイル) の解析/アクティビティへのインポートを即座にトリガーするアクション ボタンです。 要求の [テスト] ボタン - 設計時に、設定した要求を実行するアクション ボタンです。実行中は [キャンセル] に切り替わります。テストが完了するかキャンセルされると [テスト] に戻り、書式設定された応答またはエラーで [レポート] フィールドが更新されます。 レポート - 直前の cURL のインポートまたは設計時テストの実行結果 (成功の概要、マッピングの詳細、警告、エラー) を表示するために使用される複数行のテキスト領域です。
クライアントのオプション このセクションでは、接続関連の設定を定義できます。	SSL 検証を無効化 - SSL セキュリティ チェックをスキップします。テストには有用ですが (True)、運用環境には推奨されません (既定値は False)。 TLS プロトコル - セキュリティで保護された接続用の TLS プロトコルを選択します。利用可能なオプションは、[自動] (既定)、[TLS 1.2]、[TLS 1.3] です。 Cookie を有効化 - 既定で Cookie の自動処理が有効化されます (True)。Cookie の自動処理を無効化するには、False に設定します。 クライアント証明書 - セキュアな API で認証するためのクライアント証明書へのパスを示します。たとえば、"C:/certificates/client-cert.pfx"のようになります。 クライアント証明書のセキュリティで保護されたパスワード - 指定したクライアント証明書のセキュリティで保護されたパスワードを保存します。たとえば、"certPassword" のようになります。 プレーン テキストのパスワードとセキュリティで保護されたパスワードを切り替えるには、プラス記号のアイコンを選択し、[プレーンな文字列を使用] と [セキュリティで保護された文字列を使用] のいずれかを選択します。 プロキシ構成 - 認証やバイパス リストのサポートなど、カスタム プロキシを構成します。たとえば、"http://proxy.example.com:8080"のようになります。
認証 このセクションでは、アクティビティがサーバーに対して自身を認証する方法を定義できます。	認証 - 認証方法を選択します。利用可能なオプションは次のとおりです。 認証なし - サーバーは要求を受け入れるためにユーザー検証を必要としません。 基本認証 - ユーザー名とセキュリティで保護されたパスワードを使用して、受信サーバーにユーザー検証を提供します。 プレーン テキストのパスワードとセキュリティで保護されたパスワードを切り替えるには、プラス記号のアイコンを選択し、[プレーンな文字列を使用] と [セキュリティで保護された文字列を使用] のいずれかを選択します。 ベアラー トークン - ログイン後に生成された一意のベアラー トークンを通じて、受信サーバーにユーザー検証を提供します。 ネゴシエート認証 - HTTP ネゴシエート スキームを使用し、実行時にサーバー チャレンジに基づいて Kerberos または NTLM (および任意で Digest) を選択します。[認証] が [ネゴシエート認証] に設定されていて、[オペレーティング システムの資格情報を使用] = [True] である場合、OS の現在のユーザー コンテキスト (Windows の場合は Windows ログオン トークン、Linux/macOS の場合は既存の Kerberos チケット (例: kinit から取得)) が使用されます。[オペレーティング システムの資格情報を使用] = [False] に設定すると、[カスタムの資格情報] フィールドが有効化されます。このフィールドに、ネットワーク資格情報 (ドメイン/ユーザー名/パスワードまたはセキュリティで保護されたパスワード) を指定します。
要求のオプション このセクションでは、要求の動作を定義できます。	追加の Cookie - 追加の Cookie をキーと値のペアとして手動で指定します。 要求のタイムアウト - 要求が中止されるまでの最大待機時間をミリ秒単位で指定します。既定値は 10,000 ミリ秒 (10 秒) です。 エラー発生時に実行を継続 - アクティビティでエラーが発生した場合でも、オートメーションを継続するかどうかを指定します (True、既定のオプション)。エラー発生時にオートメーションを停止するには、False を使用します。 リダイレクトをフォロー - 要求がサーバーによって提供される URL リダイレクトを自動的にフォローするかどうかを指定します (True、既定のオプション)。リダイレクトを無視して初期応答を使用するには、False を使用します。 最大リダイレクト数 - 要求が停止するまでにフォローする自動リダイレクトの数を指定します。既定値は 3 です。
リトライ ポリシー このセクションでは、要求が失敗した場合のリトライ メカニズムを定義できます。	リトライ ポリシーの種類 - 要求をリトライする方法を指定します。利用可能なオプションは次のとおりです。 リトライなし - 要求はサーバーを 1 回だけ呼び出します。失敗した場合、それ以上の試行は行われません。 基本のリトライ - 失敗した後に、一定の時間待機してから要求をリトライします。 リトライ回数 - リトライの回数を指定します。既定値は 3 です。 待機 - リトライ間の固定された待機時間をミリ秒単位で指定します。既定値は 500 ミリ秒 (0.5 秒) です。 Retry-After ヘッダーを使用 - サーバーが推奨する Retry-After ヘッダーを要求で使用するかどうかを決定します (True、既定のオプション)。Retry-After ヘッダー値を無視するには、False を使用します。 待機時間の上限 - Retry-After によるリトライ間で許可される最大待機時間をミリ秒単位で指定します。既定値は 30,000 ミリ秒 (30 秒) です。 リトライのステータス コード - リトライをトリガーするステータス コードを指定します。 指数バックオフ - リトライのたびに、各リトライ間の待機時間を延長します。 リトライ回数 - リトライの回数を指定します。既定値は 3 です。 初期待機時間 - 最初のリトライを実行するまでの待機時間をミリ秒単位で指定します。既定値は 500 ミリ秒 (0.5 秒) です。 乗数 - 要求が失敗するたびに待機時間を延長するために使用する数値を指定します。既定値は 2 で、毎回待機時間を 2 倍に延長します。 ジッターを使用 - 待機時間に対して、リトライの同期を回避するために 0 〜 100 ミリ秒のランダムなオフセットを追加するかどうかを決定します (True、既定値)。 Retry-After ヘッダーを使用 - サーバーが推奨する Retry-After ヘッダーを要求で使用するかどうかを決定します (True、既定のオプション)。Retry-After ヘッダー値を無視するには、False を使用します。 待機時間の上限 - Retry-After によるリトライ間で許可される最大待機時間をミリ秒単位で指定します。既定値は 30,000 ミリ秒 (30 秒) です。 リトライのステータス コード - リトライをトリガーするステータス コードを指定します。
応答オプション このセクションは、サーバーが応答を返す方法をカスタマイズするのに役立ちます。	応答を常にファイルとして保存 - 添付ファイルのファイル名を推測できない場合でも、応答本文を強制的にディスクに書き込みます。 デバッグ情報を有効化 - 拡張デバッグ キャプチャ (生の要求/応答メタデータ、ヘッダーのスナップショット、タイミング、リトライの詳細) を有効化し、応答オブジェクトに出力するか、設計時のテスト中に出力します。 出力ファイル名 - サーバーによって提供されたファイル名 (例: Content-Disposition からのファイル名) を上書きします。 出力ファイルのターゲット フォルダー - 保存される応答ファイルの保存先フォルダーを制御します。 ファイルがすでに存在する場合 - 対象のフォルダーに解決済みの名前のファイルがすでに存在する場合における競合回避戦略を定義します。オプション: 名前を自動変更 - 増分サフィックス (_1、_2、...) を追加して、一意のファイル名を生成します。 置換 - 既存のファイルを上書きします。 停止して破棄 - 既存のファイルをそのまま残し、保存操作を中止します (例外が処理されない場合はワークフローも中止します)。
出力 このセクションでは、サーバーによって返される応答をキャプチャして保存できます。	応答コンテンツ - サーバーからの応答をキャプチャし、後で処理できるように変数に保存します。以下の項目が含まれます。 StatusCode - HTTP 応答のステータス コード。 TextContent - プレーン テキストとしての応答 (使用可能な場合)。 BinaryContent - テキスト以外のコンテンツの生の応答データ。 File - 応答は、ダウンロード フォルダーにファイル (ILocalResource) として保存されます。ファイル名は応答ヘッダーから取得するか、ファイルを上書きしないように自動生成されます。 Headers - すべての HTTP 応答ヘッダー。 ContentHeaders - 特に応答コンテンツに関連するヘッダー。たとえば、Content-Type や Content-Length などです。 RawRequestDebuggingInfo - キャプチャされた低レベルの要求/応答の詳細 (例: 構築された要求行、ヘッダー、リトライ、タイミング) を含む任意の文字列です。デバッグが有効化されている場合にのみ入力されます。有効化されていない場合は空の文字列になります。