Orchestrator への HTTP 要求

UiPath.Core.Activities.OrchestratorHttpRequest

説明

実行中のロボットで認証することにより Orchestrator API に HTTP 要求を送信します。GET、POST、PUT、PATCH、および DELETE 動詞を使用してデータを抽出したり、データを操作したり、JSON を介して特定の情報を送信したりすることができます。実行している要求の内容に応じて、要求ごとに Orchestrator ロボットのロールに異なる権限が必要となる可能性があり、ロボットを Orchestrator に接続する必要があります。たとえば、組織単位で PUT 要求を実行するには、表示、作成、および編集の権限が必要です。このアクティビティは、実行するロボットの下で実行されます。

プロジェクトの対応 OS

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

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

• Orchestrator のフォルダー - アクティビティで使用する Orchestrator フォルダーのパスです。
• Method - Orchestrator API を呼び出すときに使用する要求メソッドです。HTTP 動詞 GET、POST、PUT、PATCH および DELETE がサポートされています。既定では、GET 動詞が選択されています。
• RelativeEndpoint - ベースの Orchestrator URL を基準にして要求を作成するエンドポイントです。
• JSONPayload - 指定した Orchestrator エンドポイントに送信する JSON 形式の情報です。JSON はインデントしてはいけません。このフィールドは、文字列、String 型変数、または文字列式のみをサポートします。

その他のオプション

オプション

• Target.Timeout (milliseconds) - エラーがスローされる前にアクティビティが実行されるまで待機する時間 (単位: ミリ秒) を指定します。既定値は、30000 ミリ秒 (30 秒) です。
• エラー発生時に実行を継続 - アクティビティでエラーが発生した場合でも、オートメーションを継続するかどうかを指定します。このフィールドでは Boolean 値 (True、False) のみサポートされています。既定値は false です。その結果、フィールドを設定していない場合にエラーが発生すると、プロジェクトの実行が停止します。値を true に設定すると、エラーの発生に関係なくプロジェクトの実行は継続されます。

出力

• ヘッダー - 要求によって返されるヘッダーへの参照です。
• JSONResponse - HTTP 要求によって String 型変数として返される JSON です。
• ステータス コード - HTTP 要求によって整数変数として返されるステータス コードです。

Windows - レガシでの設定

プロパティ パネル

共通

• エラー発生時に実行を継続 - アクティビティでエラーが発生した場合でも、オートメーションを継続するかどうかを指定します。このフィールドでは Boolean 値 (True、False) のみサポートされています。既定値は False です。その結果、フィールドが空白の場合にエラーが発生すると、プロジェクトの実行が停止します。値を True に設定すると、プロジェクトの実行はエラーに関係なく継続されます。
• 表示名 - アクティビティの表示名です。
• Target.Timeout (milliseconds) - エラーがスローされる前にアクティビティが実行されるまで待機する時間 (単位: ミリ秒) を指定します。既定値は、30000 ミリ秒 (30 秒) です。

入力

• JSONPayload - 指定した Orchestrator エンドポイントに送信する JSON 形式の情報です。JSON はインデントしてはいけません。このフィールドは、文字列、String 型変数、または文字列式のみをサポートします。
• Method - Orchestrator API を呼び出すときに使用する要求メソッドです。HTTP 動詞 GET、POST、PUT、PATCH および DELETE がサポートされています。既定では、GET 動詞が選択されています。
• RelativeEndpoint - ベースの Orchestrator URL を基準にして要求を作成するエンドポイントです。

その他

• フォルダー パス - 要求が作成されるフォルダーのパスです (プロセスが実行されているフォルダーと異なる場合)。このフィールドでは文字列値のみがサポートされており、サブフォルダーを示す区切り文字として / を使用します。たとえば "Finance/Accounts Payable" です。
• プライベート - オンにした場合、変数および引数の値が Verbose レベルでログに出力されなくなります。

出力

• ヘッダー - 要求によって返されるヘッダーへの参照です。
• JSONResponse - HTTP 要求によって String 型変数として返される JSON です。
• ステータス コード - HTTP 要求によって整数変数として返されるステータス コードです。

たとえば、次のスクリーンショットの要求では、ロボットが接続されている Orchestrator で新しい組織単位、ドキュメントを作成できます。この JSON 応答とステータス コードは変数として保存されます。