Orchestrator への HTTP 要求

実行中のロボットで認証することにより Orchestrator API に HTTP 要求を送信します。GET、POST、PUT、PATCH、および DELETE 動詞を使用してデータを抽出したり、データを操作したり、JSON を介して特定の情報を送信したりすることができます。

実行している要求の内容に応じて、要求ごとに Orchestrator ロボットのロールに異なる権限が必要となる可能性があり、ロボットを Orchestrator に接続する必要があります。たとえば、組織単位で PUT 要求を実行するには、表示、作成、および編集の権限が必要です。このメソッドは、実行するロボットの下で実行されます。

定義

名前空間: UiPath.Activities.System.API

アセンブリ： UiPath.System.Activities.Api (UiPath のUiPath.System.Activities.Api.dll)

オーバー ロード

OrchestratorHTTPRequest(OrchestratorHttpMethods, String)	目的の要求とエンドポイントを使用して、Orchestrator API に HTTP 要求を実行します。
OrchestratorHTTPRequest(OrchestratorHttpMethods, String, Dictionary<String, String>, String)	目的の要求、エンドポイント、応答ヘッダーを使用して、Orchestrator API に HTTP 要求を実行します。
OrchestratorHTTPRequest(OrchestratorHttpMethods, String, String, String)	目的の要求、エンドポイント、JSON ペイロードを使用して、Orchestrator API に HTTP 要求を実行します。
OrchestratorHTTPRequest(OrchestratorHttpMethods, String, String Dictionary<String, String>, String, String)	目的の要求、エンドポイント、JSON ペイロード、応答ヘッダーを使用して、Orchestrator API に HTTP 要求を実行します。
OrchestratorHTTPRequest(OrchestratorHttpMethods, String, String, String Dictionary<String, String>, String, Int32)	目的の要求、エンドポイント、JSON ペイロード、応答ヘッダー、その他の設定を使用して、Orchestrator API に HTTP 要求を実行します。

OrchestratorHTTPRequest(OrchestratorHttpMethods, String)

目的の要求とエンドポイントを使用して、Orchestrator API に HTTP 要求を実行します。

int OrchestratorHTTPRequest(
    OrchestratorAPIHttpMethods method,
    string relativeEndpoint
)

method OrchestratorAPIHttpMethods : Orchestrator API を呼び出すときに使用する要求メソッドです。サポートされている HTTP 動詞は、 GET、 POST、 PUT、 PATCH 、および DELETEです。

relativeEndpoint 文字列 : Orchestrator のベース URL を基準にした、要求を行うエンドポイントです。

OrchestratorHTTPRequest(OrchestratorHttpMethods, String, Dictionary<String, String>, String)

目的の要求、エンドポイント、JSON ペイロードを使用して、Orchestrator API に HTTP 要求を実行します。

int OrchestratorHTTPRequest(
    OrchestratorAPIHttpMethods method,
    string relativeEndpoint,
    out Dictionary<string, string> responseHeaders,
    out string result
)

method OrchestratorAPIHttpMethods : Orchestrator API を呼び出すときに使用する要求メソッドです。サポートされている HTTP 動詞は、 GET、 POST、 PUT、 PATCH 、および DELETEです。

relativeEndpoint 文字列 : Orchestrator のベース URL を基準にした、要求を行うエンドポイントです。

responseHeaders Dictionary<String, String> : 要求によって返されるヘッダーへの参照です。

result String : HTTP 要求により返される JSON です。

OrchestratorHTTPRequest(OrchestratorHttpMethods, String, String, String)

目的の要求、エンドポイント、JSON ペイロード、応答ヘッダー、その他の設定を使用して、Orchestrator API に HTTP 要求を実行します。

int OrchestratorHTTPRequest(
    OrchestratorAPIHttpMethods method,
    string relativeEndpoint,
    string jSONPayload,
    string folderPath
)

method OrchestratorAPIHttpMethods : Orchestrator API を呼び出すときに使用する要求メソッドです。サポートされている HTTP 動詞は、 GET、 POST、 PUT、 PATCH 、および DELETEです。

relativeEndpoint 文字列 : Orchestrator のベース URL を基準にした、要求を行うエンドポイントです。

jSONPayload String : 指定した Orchestrator エンドポイントに送信する JSON 形式の情報です。JSON はインデントしてはいけません。

folderPath string : 使用する Orchestrator フォルダーのパスです。

OrchestratorHTTPRequest(OrchestratorHttpMethods, String, String Dictionary<String, String>, String, String)

目的の要求、エンドポイント、JSON ペイロード、応答ヘッダーを使用して、Orchestrator API に HTTP 要求を実行します。

int OrchestratorHTTPRequest(
    OrchestratorAPIHttpMethods method,
    string relativeEndpoint,
    string jSONPayload,
    out Dictionary<string, string> responseHeaders,
    out string result,
    string folderPath
)

method OrchestratorAPIHttpMethods : Orchestrator API を呼び出すときに使用する要求メソッドです。サポートされている HTTP 動詞は、 GET、 POST、 PUT、 PATCH 、および DELETEです。

relativeEndpoint 文字列 : Orchestrator のベース URL を基準にした、要求を行うエンドポイントです。

jSONPayload String : 指定した Orchestrator エンドポイントに送信する JSON 形式の情報です。JSON はインデントしてはいけません。

responseHeaders Dictionary<String, String> : 要求によって返されるヘッダーへの参照です。

result String : HTTP 要求により返される JSON です。

folderPath string : 使用する Orchestrator フォルダーのパスです。

OrchestratorHTTPRequest(OrchestratorHttpMethods, String, String, String Dictionary<String, String>, String, Int32)

目的の要求、エンドポイント、JSON ペイロード、応答ヘッダー、その他の設定を使用して、Orchestrator API に HTTP 要求を実行します。

int OrchestratorHTTPRequest(
    OrchestratorAPIHttpMethods method,
    string relativeEndpoint,
    string jSONPayload,
    string folderPath,
    out Dictionary<string, string> responseHeaders,
    out string result,
    int timeoutMS
)

method OrchestratorAPIHttpMethods : Orchestrator API を呼び出すときに使用する要求メソッドです。サポートされている HTTP 動詞は、 GET、 POST、 PUT、 PATCH 、および DELETEです。

relativeEndpoint 文字列 : Orchestrator のベース URL を基準にした、要求を行うエンドポイントです。

jSONPayload String : 指定した Orchestrator エンドポイントに送信する JSON 形式の情報です。JSON はインデントしてはいけません。

folderPath string : 使用する Orchestrator フォルダーのパスです。

responseHeaders Dictionary<String, String> : 要求によって返されるヘッダーへの参照です。

result String : HTTP 要求により返される JSON です。

timeoutMS Int32 : アクティビティの実行が完了するまで待機する時間をミリ秒単位で指定します。指定した時間が経過しても実行が完了しない場合には例外をスローします。既定値は 30000 ミリ秒 (30 秒) です。

戻り値

Int32

要求により返されたステータス コードです。