HTTP 要求

UiPath.Web.Activities.Http.NetHttpClient

重要:

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

説明

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

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

プロジェクトの対応 OS

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

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

アクティビティの本体のプロパティ
要求メソッド *	HTTP 要求がサーバーと対話する方法を選択します。 GET - データを変更せずに取得します。 POST - サーバーにデータを送信します。通常は、リソースを作成または更新します。 PUT - 既存のリソースを更新します。 DELETE - 指定したリソースをサーバーから削除します。 HEAD - GET に似ていますが、本文の内容のないヘッダーのみを取得します。 オプション - サーバーで利用可能な通信オプションに関する情報を提供します。 PATCH - 既存のリソースを部分的に更新します。 TRACE - 診断目的で使用され、受信した要求をクライアントにエコー バックします。
要求 URL *	要求を送信するサーバーの Web アドレスを指定します。たとえば、https://store.example.com/searchのようになります。
パラメーター	サーバー固有の詳細情報をキーと値のペアとして要求に追加します。たとえば、「query: "laptop"」、「sortBy: "price"」のようになります。
ヘッダー	サーバー固有の指示または認証の詳細をキーと値のペアとして追加します。たとえば、「Authorization: "Bearer <your_access_token>"」、「Accept: "application/json"」のようになります。
要求本文の種類 *	サーバーに送信するコンテンツの種類を選択します。 なし - 通常はメソッドを取得するために、データを送信しません。 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") ストリーム - データを一度にメモリに完全には読み込めない場合に、大きなファイル (音声やビデオ) のアップロードなど、継続的なデータを送信します。このオプションを選択すると、次のフィールドが表示されます。 ローカル ファイル - 大きなファイルのパスを指定します。このアクティビティは、アップロードされたファイルに正しい Content-Type ヘッダーを自動的に割り当てます。このヘッダーは手動で上書きできます。例: File.OpenRead("C:/Videos/large-video.mp4")

プロパティ パネル
[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 (および必要に応じてダイジェスト) を選択します。認証が ネゴシエート認証 に設定され、オペレーティング システムの資格情報を使用する = True に設定されている場合、現在の OS ユーザー コンテキスト (Windows ログオン トークン、Linux/macOS では既存の Kerberos チケット (kinit など) が使用されます)。[オペレーティング システムの資格情報を使用] = [False] を設定して、[カスタム資格情報] フィールドを有効化します。NetworkCredential (ドメイン/ユーザー名/パスワードまたはセキュリティで保護されたパスワード) を指定します。
要求のオプション このセクションでは、要求の動作を定義できます。	追加の Cookie - 追加の Cookie をキーと値のペアとして手動で指定します。 要求のタイムアウト - 要求が中止されるまでの最大待機時間をミリ秒単位で指定します。既定値は 10,000 ミリ秒 (10 秒) です。 エラー発生時に実行を継続 - アクティビティでエラーが発生した場合でもオートメーションを継続するかどうかを指定します ( True 、既定のオプション)。エラー発生時にオートメーションを停止するには、 False を使用します。 Follow redirects - サーバーが提供する URL リダイレクトに要求が自動的に従うかどうかを指定します ( True 、既定のオプション)。リダイレクトを無視して最初の応答を使用するには、 False を使用します。 最大リダイレクト数 - 停止するまでに要求する自動リダイレクトの回数を指定します。既定値は 3 です。
リトライ ポリシー このセクションでは、要求が失敗した場合のリトライ メカニズムを定義できます。	リトライ ポリシーの種類 - 要求をリトライする方法を指定します。利用可能なオプションは次のとおりです。 リトライなし - 要求はサーバーに 1 回だけ呼び出します。失敗した場合、それ以上の試行は行われません。 基本的なリトライ - 失敗した後に、固定の遅延で要求をリトライします。 リトライ回数 - リトライする回数を指定します。既定値は 3 です。 遅延 - リトライ間の固定時間をミリ秒単位で指定します。既定値は 500 ミリ秒 (0.5 秒) です。 Retry-After ヘッダーを使用 - サーバーが推奨する Retry-After ヘッダーを要求で使用するかどうかを決定します ( True 、既定のオプション)。Retry-After ヘッダー値を無視するには、False を使用します。 遅延制限 - リトライ後の リトライ間に許容される最大遅延をミリ秒単位で指定します。既定値は 30,000 ミリ秒 (30 秒) です。 リトライのステータス コード - リトライをトリガーするステータス コードを指定します。 指数バックオフ - 各試行間の遅延を増やしてリトライします。 リトライ回数 - リトライする回数を指定します。既定値は 3 です。 開始遅延 - 最初のリトライまでの遅延時間をミリ秒単位で指定します。既定値は 500 ミリ秒 (0.5 秒) です。 乗数 - 要求が失敗するたびに遅延を増やすために使用する数値を指定します。既定値は 2 で、毎回遅延が 2 倍になります。 ジッターを使用 - 遅延の場合、同期された再試行を回避するために 0 から 100 ミリ秒の間のランダムなオフセットを追加するかどうかを指定します ( True 、デフォルト)。 Retry-After ヘッダーを使用 - サーバーが推奨する Retry-After ヘッダーを要求で使用するかどうかを決定します ( True 、既定のオプション)。Retry-After ヘッダー値を無視するには、False を使用します。 遅延制限 - リトライ後の リトライ間に許容される最大遅延をミリ秒単位で指定します。既定値は 30,000 ミリ秒 (30 秒) です。 リトライのステータス コード - リトライをトリガーするステータス コードを指定します。
応答オプション このセクションは、サーバーが応答を返す方法をカスタマイズするのに役立ちます。	常に tesponse をファイルとして保存 - 添付ファイルのファイル名が推論されない場合でも、応答本文を強制的にディスクに書き込みます。 デバッグ情報を有効化 - 拡張デバッグ キャプチャ (生の要求/応答メタデータ、ヘッダー、スナップショット、タイミング、リトライの詳細) を有効化し、応答オブジェクトに出力するか、設計時のテスト中に出力します。 出力ファイル名 - サーバー提供のファイル名を上書きします (例: Content-Disposition から)。 出力ファイルのターゲット フォルダー - 保存される応答ファイルの保存先フォルダーを制御します。 ファイルがすでに存在する場合 - 解決された名前のファイルがターゲット フォルダーに既に存在する場合の競合戦略を定義します。オプション： 名前を自動変更 - 増分のサフィックス (_1、_2、...) を追加して、一意のファイル名を生成します。 置換 - 既存のファイルを上書きします。 停止して破棄 - 既存のファイルをそのまま残し、保存操作を中止します (例外が処理されない場合はワークフローも中止します)。 注: このアクティビティでは、一度に 1 つの出力モードのみがサポートされています。応答をファイルとして保存するか、応答データをテキストとして返します。両方の出力を同時に設定することはできません。
出力 このセクションでは、サーバーによって返される応答をキャプチャして保存できます。	応答コンテンツ - サーバーからの応答をキャプチャし、後で処理できるように変数に格納します。以下の項目が含まれます。 ステータス コード - HTTP 応答のステータス コードです。 TextContent - プレーン テキストとしての応答 (利用可能な場合) BinaryContent - テキスト以外のコンテンツの生の応答データです。 ファイル - 応答は、ダウンロード フォルダーにファイル ( ILocalResource ) として保存されます。ファイル名は応答ヘッダーから取得するか、ファイルを上書きしないように自動生成されます。 ヘッダー - すべての HTTP 応答ヘッダーです。 ContentHeaders - 応答の内容に特に関連するヘッダーです。たとえば、 Content-Type と Content-Length です。 RawRequestDebuggingInfo - キャプチャした低レベルの要求/応答の詳細を含む任意の文字列 (例:構築された要求行、ヘッダー、再試行、タイミング) は、デバッグが有効な場合にのみ設定されます。それ以外の場合は空の文字列。