エンドポイントの呼び出し

UiPath.Workato.Activities.InvokeEndpoint

[エンドポイントを呼び出し] アクティビティは、Workato API を使用してレシピを呼び出します。

Workato エンドポイントへの呼び出しの実行後、アクティビティはエンドポイント固有のフィールド値 (該当する場合) と要求のステータス (成功/失敗情報) を、後続のアクティビティ (例: 条件ロジック) で使用できる ResponseStatus オブジェクト ([応答ステータス]) に出力します。

動作のしくみ

以下の手順とメッセージ シーケンス ダイアグラムは、設計時 (つまり、アクティビティの依存関係と入/出力プロパティ) から実行時に至るまでの、アクティビティの動作のしくみの例を示したものです。

1. 「セットアップ」の手順を完了します。
2. プロジェクトに [ Workato スコープ ] アクティビティを追加します。
3. [Workato スコープ] アクティビティ内に [エンドポイントを呼び出し] アクティビティを追加します。
4. [エンドポイントを呼び出し] アクティビティの [設定] ボタンをクリックします (オブジェクト ウィザードが開きます)。
5. [API コレクション] ドロップダウン リストから、呼び出すエンドポイントを含む API コレクション を選択します。
6. [エンドポイント] ドロップダウン リストから、呼び出す エンドポイント を選択します。
7. エンドポイントの呼び出しに使用する資格情報を入力します。
8. オブジェクト ウィザードで返されるフィールドに値を入力します。
9. [出力] プロパティと、[方向] の値が [Out] のすべてのフィールドの、ResponseStatus 変数を作成して入力します。

アクティビティの本体

[エンドポイントを呼び出し] のプロパティ値を入力するには、[設定] ボタンをクリックしてオブジェクト ウィザードを使用する必要があります。ウィザードで選択した操作の入力プロパティと出力プロパティの両方をダイアログで指定できます。

オブジェクト ウィザードの詳細については、「ビジネス アクティビティのフレームワーク」のページをご覧ください。

注:

プロパティ リストに表示されるプロパティは、選択した Workato エンドポイントで指定されているプロパティです。GET 動詞を使用するエンドポイントには、明示的なプロパティとデータ型を持つオプションがあります。他のすべての REST 動詞 (POST、PUT など) には、入力プロパティ用の 1 つの body 入力フィールド (jObject) があります。

プロパティ

共通

• 表示名 - アクティビティの表示名です。このフィールドは Strings または String 型変数のみをサポートします。

その他

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

出力

• 応答ステータス - 要求のステータスです (成功/失敗に関する情報)。ResponseStatus 型変数を入力します (UiPath.BAF.Models.ResponseStatus)。ResponseStatus オブジェクトには、他のアクティビティで使用できる 3 つのプロパティが含まれています。
  • Success - Boolean - API 要求が成功したかどうかを示します。
  • ErrorCode - String - API 要求が成功しなかった場合の応答エラーです (Success = False)。
  • Message - String - エラー メッセージです。