HTTP 要求

UiPath.WebAPI.Activities.HttpClient

説明

指定された Web API に対する HTTP 要求を実行できます。最初にこのアクティビティを デザイナー パネルにドラッグすると、[HTTP 要求ウィザード] ウィンドウが表示され、要求の作成と、サーバー応答のプレビューを簡単に行うことができます。

注: 返された HTTP ステータス コード (StatusCode) が 0 の場合、サーバーが何らかの理由で実際の応答を返さなかったことを意味します。これは通常、接続またはネットワークの問題が発生している可能性があることを示しています。

重要: Web API パッケージは、UiPath.Salesforce.Activities および UiPath.Jira.Activities アクティビティに対応していません。

プロジェクトの対応 OS

Windows - レガシ | Windows | クロスプラットフォーム

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

• 要求メソッド - API を呼び出すときに使用する要求メソッドです。HTTP 動詞 GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCH および MERGE がサポートされています。既定では、GET メソッドが選択されています。
• 要求 URL - 要求を作成するための URL です。カスタム セグメントは、中括弧「{}」の間に配置し、[パラメーター] セクションで定義する必要があります。たとえば、URL https://platform.uipath.com/odata/Robots(28) は https://platform.uipath.com/odata/Robots{id} と記述でき、id パラメーターの値は [URL セグメント] ウィンドウで指定できます。
• パラメーター - 要求パラメーターです。このフィールドをクリックすると、[ディクショナリ] ウィンドウが開きます。
• ヘッダー - HTTP 要求にカスタム ヘッダーを含めることができます。このフィールドをクリックすると、[ディクショナリ] ウィンドウが開きます。
• Body - 要求の本文です。
• Authentication - API の呼び出し時に使用する認証プロトコルを指定します。次のプロトコルがサポートされています。
  • None - 既定のオプションです。要求を送信している Web サーバーが認証プロトコルを必要としない場合に使用します。
  • Simple Http - 要求を行う API が単純な HTTP 認証プロトコルを使用している場合は、このオプションを選択する必要があります。選択した場合、[ユーザー名] と [パスワード] の 2 つの追加フィールドが表示されます。これらのフィールドには、指定した API の有効な資格情報を入力する必要があります。
  • OAuth1 - 要求を行う API が OAuth1 プロトコルを使用している場合は、このオプションを選択する必要があります。選択した場合、[Consumer Key]、[Consumer Secret]、[Access Token]、[Access Token Secret] の 4 つの追加のフィールドが表示されます。
  • OAuth2 - 要求を行う API が OAuth2 プロトコルを使用している場合は、このオプションを選択する必要があります。選択した場合、[Access Token] フィールドが表示されます。このアクセス トークンは、通常、指定した API への別の HTTP 要求への応答として生成されます。
  • クライアント証明書 - API 呼び出しを完了するためにクライアント証明書が必要な場合は、このオプションを選択する必要があります。選択した場合、次の 2 つの追加フィールドが表示されます。
    • クライアント証明書 - クライアント証明書ファイルがある場所のフル パスです。サポートされている証明書のエンコードは X.509 です。サポートされている拡張子は .pfx と .p12 です。
    • クライアント証明書のパスワード - クライアント証明書ファイルのエクスポート時に設定したパスワードです。

Advanced (カスタム)

オプション

• Target.Timeout (milliseconds) - エラーがスローされるまでにアクティビティが待機する時間 (単位: ミリ秒) を指定します。既定値は、6000 ミリ秒 (6 秒) です。
• エラー発生時に実行を継続 - アクティビティでエラーが発生した場合でも、オートメーションを継続するかどうかを指定します。このフィールドでは Boolean 値 (True、False) のみサポートされています。既定値は False です。その結果、フィールドを設定していない場合にエラーが発生すると、プロジェクトの実行が停止します。値を True に設定すると、プロジェクトの実行はエラーに関係なく継続されます。
• SSL 証明書の検証 - 選択した場合、要求を送信する際に SSL 証明書が検証されます。検証に失敗すると、要求は中止されます。
• 応答形式 - Web サーバーの応答を受け取る形式です。次のオプションがサポートされています。ANY - 既定値、XML、JSON、および CUSTOM。CUSTOM 応答形式を選択した場合、Accept または accept ヘッダー パラメーターが存在すると、カスタム受け入れ形式として送信されます。ヘッダー パラメーターが設定されていない場合、accept は RestSharp の既定値である次の値を取得します。

  application/json, application/xml, text/json, text/x-json, text/javascript,
        text/xml

  .
• 添付ファイル - 要求の添付ファイルのリストです。
• 応答の添付ファイルのファイル名 - 要求により返されるファイルに使用するファイル名です。
• 本文形式 - 本文の形式を指定します。既定では、application/xml に設定されています。このフィールドは、文字列と String 型変数をサポートします。
• Cookie - HTTP 要求内の Cookie です。このフィールドをクリックすると、[ディクショナリ] ウィンドウが開きます。
• URL セグメント - 中括弧「{}」で囲まれた、エンドポイント URL に追加されるカスタム セグメントです。このフィールドをクリックすると、[ディクショナリ] ウィンドウが開きます。たとえば、URL https://platform.uipath.com/odata/Robots(28) は https://platform.uipath.com/odata/Robots{id} と記述でき、id パラメーターの値は [ディクショナリ] ウィンドウで指定できます。このフィールドは、文字列と String 型変数をサポートします。

出力

• 応答コンテンツ - HTTP 要求から String 型変数として受け取る応答です。
• 応答ステータス - HTTP 要求から整数変数として受け取るステータス コードです。
• 応答ヘッダー - HTTP 要求から受け取る応答です。
• 応答の添付ファイル - 応答から保存される添付ファイルです。

Windows および Windows - レガシでの設定

インポート ウィザード ウィンドウ

このファイルを使用して、CURL 形式で HTTP 要求をインポートできます。

HTTP 要求ウィザードウィンドウ

このウィザードにあるすべてのフィールドは、[プロパティ] パネルでも使用できます。その結果、ウィザードを終了した後でも、環境設定を編集することができます。ハードコードされた値または変数を使用して、ウィザードでアクティビティを設定できます。

注: 変数を使用している場合、プレビュー機能は利用できません。

Request Builder タブ

• エンドポイント - 要求を作成するための URL です。カスタム セグメントは、中括弧「{}」の間に配置し、[パラメーター] セクションで定義する必要があります。たとえば、この URL https://platform.uipath.com/odata/Robots(28) は https://platform.uipath.com/odata/Robots({id}) と記述でき、 パラメーターの値は [URL セグメント] として [パラメーター] セクションで指定できます。
• Preview URL - [パラメーター] セクションで提供される情報を考慮して、[End Point] フィールドに表示される URL のプレビューです。
• SSL 証明書の検証を有効化 - 要求を送信する際に SSL 証明書を検証する場合は、このボックスをオンにします。検証に失敗すると、要求は中止されます。
• タイムアウト - エラーがスローされる前にアクティビティが実行されるまで待機する時間 (ミリ秒単位) を指定します。既定値は 6000 ミリ秒 (6 秒) です。

• Client Certificate - クライアント証明書ファイルが保存されている場所。フル パスを指定する必要があります。

  注: パスは、引用符で囲まないでください。
• Client Certificate Password - 使用中のクライアント証明書に対応するパスワードです。
• 要求メソッド - API を呼び出すときに使用する要求メソッドです。HTTP 動詞 GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCH および MERGE がサポートされています。既定では、GET メソッドが選択されています。

• Authentication - API の呼び出し時に使用する認証プロトコルを指定します。次のプロトコルがサポートされています。

  • None - 既定のオプションです。要求を送信している Web サーバーが認証プロトコルを必要としない場合に使用します。
  • Simple Http - 要求を行う API が単純な HTTP 認証プロトコルを使用している場合は、このオプションを選択する必要があります。選択した場合、[ユーザー名] と [パスワード] の 2 つの追加フィールドが表示されます。これらのフィールドには、指定した API の有効な資格情報を入力する必要があります。
  • OAuth1 - 要求を行う API が OAuth1 プロトコルを使用している場合は、このオプションを選択する必要があります。選択した場合、[Consumer Key]、[Consumer Secret]、[Access Token]、[Access Token Secret] の 4 つのフィールドが表示されます。
  • OAuth2 - 要求を行う API が OAuth2 プロトコルを使用している場合は、このオプションを選択する必要があります。選択した場合、[Access Token] フィールドが表示されます。このアクセス トークンは、通常、指定した API への別の HTTP 要求への応答として生成されます。

[パラメーター] セクション

• Add Parameter - GetOrPost 型を使用して、[パラメーター] 表に新しい行を追加します。前の行が入力されていない場合、新しい行は追加されません。

• Add Header - HttpHeader 型を使用して、[パラメーター] 表に新しい行を追加します。前の行が入力されていない場合、新しい行は追加されません。

  注: ヘッダーに複数の値を追加する場合は、コンマで区切ってください (,)。
• Add URL Segment - UrlSegment 型を使用して、[パラメーター] 表に新しい行を追加します。前の行が入力されていない場合、新しい行は追加されません。
• Delete - [パラメーター] 表で選択した行を削除します。行が選択されていない場合、このボタンは無効化されます。

[パラメーター] 表

• 名前 - パラメーター、ヘッダー、または URL セグメントの名前です。
• 値 - パラメーター、ヘッダー、または URL セグメントの値です。

• 型 - 行の型です。次のオプションを使用できます。

  • GetOrPost - 行が要求で使用できるパラメーターであることを示します。
  • HttpHeader - [Parameters] 表に追加された行が、API 呼び出しを行うときに送信される要求ヘッダーであることを示します。

  • URL セグメント - 追加された行が [エンドポイント] フィールドで指定されたフラグメントまたは URL であることを示します。

    注: 場合によっては、重複するパラメーターが存在しないことを示すエラーが返されることがあります。これらは、パスワードとユーザー名のパラメーターを含める必要がある認証要求によって発生する可能性があります。このような場合は、Body プロパティを使用してパラメーターを渡すことをお勧めします。

[添付ファイル] セクション

• 添付ファイルを追加 - 新しい行を作成して、実行された HTTP 要求にファイルを追加できます。要求メソッドが、POST または PUT に設定されている場合にのみ有効化されます。
• Delete Attachment - [添付ファイル] セクションで、以前に追加した行を削除できます。
• 名前 - 添付するファイルの名前です。
• ファイル パス - 添付するファイルのフル パスです。
• 型 - 送信する情報の種類を示します。このフィールドは、添付ファイルで自動的に入力されます。プレビュー - 作成した HTTP 要求をプレビューし、[Response] タブを開くことができます。

Response タブ

このタブでは、ワークフローに含める要求をプレビューできます。このタブにアクセスするには、すべてのフィールドを入力して要求を設定した後で、HTTP 要求 ウィザードの [プレビュー] ボタンを押します。または、ウィザードの上部にあるタブを切り替えます。

このページは、次の項目で構成されています。

• 要求情報 - このセクションでは、実行された要求に関する詳細情報が表示されます。要求 URL、メソッド、およびステータス コードが表示されます。
• Preview Response - Web サーバーの応答を表示します。
• Raw Body - Web サーバーの応答を生の形式で表示します。
• 応答情報 - Web サーバーの応答に関する詳細を表示します。応答ステータスとコード、およびサポートされているコンテンツの種類ののヘッダーが表示されます。
• Download Resource - 要求されたリソースを指定したファイルにダウンロードできます。
• Refresh - 要求を再度実行できるようにします。

プロパティ パネル

クライアント証明書認証

• クライアント証明書 - クライアント証明書ファイルがある場所のフル パスです。サポートされている証明書のエンコードは X.509 です。サポートされている拡張子は .pfx と .p12 です。
• クライアント証明書のパスワード - クライアント証明書ファイルのエクスポート時に設定したパスワードです。
• SSL 証明書の検証を有効化 - 要求を送信する際に SSL 証明書を検証します。検証に失敗すると、要求は中止されます。このフィールドでは Boolean 値 ([True]、[False]) のみサポートされています。
• セキュリティで保護されたクライアント証明書パスワード - セキュリティで保護された文字列での、指定したクライアント証明書ファイルのパスワードです。このフィールドは SecureString 型変数のみをサポートします。

共通

• エラー発生時に実行を継続 - アクティビティが例外をスローした場合でも、ワークフローを継続するかどうかを指定します。このフィールドでは Boolean 値 (True、False) のみサポートされています。既定値は False です。その結果、フィールドが空白で例外がスローされると、プロジェクトの実行が停止します。値を True に設定すると、プロジェクトの実行はエラーに関係なく継続されます。

  注: このアクティビティが [トライ キャッチ] に含まれていて、[エラー発生時に実行を継続] プロパティの値が True の場合、プロジェクトが実行されたときにエラーは発生しません。
• 表示名 - アクティビティの表示名です。
• Target.Timeout (milliseconds) - エラーがスローされるまでにアクティビティが待機する時間 (単位: ミリ秒) を指定します。既定値は、6000 ミリ秒 (6 秒) です。

入力

• 応答形式 - Web サーバーの応答を受け取る形式です。次のオプションがサポートされています。ANY - 既定値、XML、JSON、および CUSTOM。CUSTOM 応答形式を選択した場合、Accept または accept ヘッダー パラメーターが存在すると、カスタム受け入れ形式として送信されます。ヘッダー パラメーターが設定されていない場合、accept は RestSharp の既定値である application/json, application/xml, text/json, text/x-json, text/javascript, text/xml を取得します。
• 要求メソッド - API を呼び出すときに使用する要求メソッドです。HTTP 動詞 GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCH および MERGE がサポートされています。既定では、GET メソッドが選択されています。
  注: [HTTP 要求] アクティビティは、バージョン 106.11.2 以前の RestSharp パッケージでのみ正しく動作します。バージョン 106.11.4 以降の RestSharp がインストールされていると、エラーが返されます。
• 要求 URL - 要求を作成するための URL です。カスタム セグメントは、中括弧「{}」の間に配置し、[パラメーター] セクションで定義する必要があります。たとえば、URL https://platform.uipath.com/odata/Robots(28) は https://platform.uipath.com/odata/Robots{id} と記述でき、id パラメーターの値は [URL セグメント] ウィンドウで指定できます。

その他

• プライベート - オンにした場合、変数および引数の値が Verbose レベルでログに出力されなくなります。

OAuth1

• ConsumerKey - 要求を行う API が OAuth1 認証プロトコルに基づいている場合に使用されるコンシューマー キーです。
• コンシューマー シークレット - 要求を行う API が OAuth1 認証プロトコルに基づいている場合に使用されるコンシューマー シークレットです。
• OAuth1Token - コンシューマーの認可要求が承認された後に、要求を行う API が OAuth1 認証プロトコルに基づいている場合に使用されるアクセス トークンです。
• OAuth1TokenSecret - コンシューマーの認可要求が承認された後に、要求を行う API が OAuth1 認証プロトコルに基づいている場合に使用されるシークレットです。

OAuth2

• OAuth2 トークン - 要求を行う API が OAuth2 認証プロトコルに基づいている場合に使用されるアクセス トークンです。このアクセス トークンは、通常、指定した API への別の HTTP 要求への応答として生成されます。

オプション

• Attachments - 要求にファイルを添付できます。[Ellipsis] ボタンをクリックして添付ファイルウィンドウを開き、必要なすべてのファイルを追加します。
• Body - 要求の本文です。
• 本文形式 - 本文の形式を指定します。既定では、application/xml に設定されています。このフィールドは、文字列と String 型変数をサポートします。
• Cookies - HTTP 要求中のクッキー。 Ellipsis (省略記号) ボタンをクリックすると、Cookies ウィンドウが開きます。
• 添付ファイル - 要求の添付ファイルのリストです。
• 応答の添付ファイルのファイル名 - 要求により返されるファイルに使用するファイル名です。
• Headers - HTTP 要求にカスタムヘッダーを含めることができます。[Ellipsis] ボタンをクリックして、[Headers] ウィンドウを開きます。
• パラメーター - 要求パラメーターです。省略記号ボタンをクリックすると、パラメーター セクションに対応する [パラメーター] ウィンドウが開きます。
• URL セグメント - カスタム セグメントは、中括弧「{}」の間の Endpoint URL に追加されます。省略記号ボタンをクリックして、[URL セグメント] ウィンドウを開きます。たとえば、URL https://platform.uipath.com/odata/Robots(28) は https://platform.uipath.com/odata/Robots{id} と記述でき、id パラメーターの値は [URL セグメント] ウィンドウで指定できます。このフィールドは文字列と String 型変数をサポートします。このフィールドは、文字列と String 型変数をサポートします。

出力

• ヘッダー - HTTP 要求から受け取る応答です。
• 応答の添付ファイル - 応答から保存される添付ファイルです。
• 応答コンテンツ - HTTP 要求から String 型変数として受け取る応答です。
• 応答ステータス - HTTP 要求から整数変数として受け取るステータス コードです。

シンプル認証

• パスワード - Web サービスが簡易認証を使用し、パスワードを入力できることを示します。ユーザー名の追加も必要です。このプロパティは、文字列と String 型変数のみをサポートします。
• セキュリティで保護されたパスワード - Web サービスがセキュリティで保護された認証を使用し、セキュリティで保護された文字列のパスワードを入力できることを示します。ユーザー名の追加も必要です。このプロパティはセキュリティで保護された String 型変数をサポートします。
• ユーザー名 - Web サービスが簡易認証を使用し、ユーザー名を入力できることを示します。パスワードの追加も必要です。このプロパティは、文字列と String 型変数をサポートします。