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

UiPath.Workato.Activities.InvokeEndpoint

[ Invoke Endpoint] アクティビティは 、Workato API を使用してレシピを呼び出します。

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

動作のしくみ

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

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

アクティビティの本体

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

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

注:

プロパティ リストに表示されるプロパティは、選択した Workato エンドポイントで指定したプロパティです。

GET 動詞を使用するエンドポイントでは、明示的なプロパティとデータ型を持つことができます。 他のすべての REST 動詞 (POST、PUT など) には、jObject である入力プロパティの 1 つの本文入力フィールドがあります。

プロパティ

共通

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

その他

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

出力

• 応答ステータス - 要求のステータスです (成功/失敗に関する情報)。 ResponseStatus 型変数を入力します (UiPath.BAF.Models.ResponseStatus)。 ResponseStatus オブジェクトには、他のアクティビティで使用できる 3 つのプロパティが含まれています。

  • Success - Boolean - API 要求が成功したかどうかを示します。
  • ErrorCode - String - API 要求が成功しなかった場合の応答エラーです (Success=False)。
  • Message - String - エラー メッセージです。