ワークフローに関するアクティビティ

最終更新日時 2024年12月20日

Orchestrator への HTTP 要求

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

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

定義

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

アセンブリ： UiPath.System.Activities.Api (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
)int OrchestratorHTTPRequest(
	OrchestratorAPIHttpMethods method,
	string relativeEndpoint
)

メソッド Orchestrator APIHTTP メソッド: Orchestrator API を呼び出すときに使用する要求メソッドです。 HTTP 動詞 GET、 POST、 PUT、 PATCH 、 DELETEがサポートされています。
エンドポイントの相対パス 文字列: ベースの 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
)int OrchestratorHTTPRequest(
	OrchestratorAPIHttpMethods method,
	string relativeEndpoint,
	out Dictionary<string, string> responseHeaders,
	out string result
)

メソッド Orchestrator APIHTTP メソッド: Orchestrator API を呼び出すときに使用する要求メソッドです。 HTTP 動詞 GET、 POST、 PUT、 PATCH 、 DELETEがサポートされています。
エンドポイントの相対パス 文字列: ベースの Orchestrator URL を基準にして要求を作成するエンドポイントです。
応答ヘッダー Dictionary<String, String>: 要求によって返されるヘッダーへの参照です。
結果文字列: HTTP 要求によって返される JSON です。

`OrchestratorHTTPRequest(OrchestratorHttpMethods, String, String, String)`

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

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

メソッド Orchestrator APIHTTP メソッド: Orchestrator API を呼び出すときに使用する要求メソッドです。 HTTP 動詞 GET、 POST、 PUT、 PATCH 、 DELETEがサポートされています。
エンドポイントの相対パス 文字列: ベースの Orchestrator URL を基準にして要求を作成するエンドポイントです。
JSON ペイロード 文字列: 指定した Orchestrator エンドポイントに送信する JSON 形式の情報です。 JSON はインデントしてはいけません。
フォルダーパス 文字列: 使用する 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
)int OrchestratorHTTPRequest(
	OrchestratorAPIHttpMethods method,
	string relativeEndpoint,
	string jSONPayload,
	out Dictionary<string, string> responseHeaders,
	out string result,
	string folderPath
)

メソッド Orchestrator APIHTTP メソッド: Orchestrator API を呼び出すときに使用する要求メソッドです。 HTTP 動詞 GET、 POST、 PUT、 PATCH 、 DELETEがサポートされています。
エンドポイントの相対パス 文字列: ベースの Orchestrator URL を基準にして要求を作成するエンドポイントです。
JSON ペイロード 文字列: 指定した Orchestrator エンドポイントに送信する JSON 形式の情報です。 JSON はインデントしてはいけません。
応答ヘッダー Dictionary<String, String>: 要求によって返されるヘッダーへの参照です。
結果文字列: HTTP 要求によって返される JSON です。
フォルダーパス 文字列: 使用する 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
)int OrchestratorHTTPRequest(
	OrchestratorAPIHttpMethods method,
	string relativeEndpoint,
	string jSONPayload,
	string folderPath,
	out Dictionary<string, string> responseHeaders,
	out string result,
	int timeoutMS
)

メソッド Orchestrator APIHTTP メソッド: Orchestrator API を呼び出すときに使用する要求メソッドです。 HTTP 動詞 GET、 POST、 PUT、 PATCH 、 DELETEがサポートされています。
エンドポイントの相対パス 文字列: ベースの Orchestrator URL を基準にして要求を作成するエンドポイントです。
JSON ペイロード 文字列: 指定した Orchestrator エンドポイントに送信する JSON 形式の情報です。 JSON はインデントしてはいけません。
フォルダーパス 文字列: 使用する Orchestrator フォルダーのパスです。
応答ヘッダー Dictionary<String, String>: 要求によって返されるヘッダーへの参照です。
結果文字列: HTTP 要求によって返される JSON です。
タイムアウト (ミリ秒) Int32: アクティビティの実行が完了するまで待機する時間をミリ秒で指定します。指定した時間が経過しても実行が完了しない場合には、例外をスローします。既定値は 30000 ミリ秒 (30 秒) です。