レシピの取得

UiPath.Workato.Activities.GetRecipeDetails

[ レシピを取得] アクティビティは、Workato の Get Recipe details API を使用して、[ Workato スコープ ] アクティビティで指定されたユーザーに属する特定のレシピ ( RecipeID ) の詳細を取得します。

get 操作が完了すると、アクティビティは詳細を Recipe オブジェクト ([レシピ]) に出力します。この出力は、後続のアクティビティで入力変数として使用できます (例: [レシピを開始]、[レシピを 停止] の Recipe.Id )。

動作のしくみ

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

1. 「セットアップ」の手順を完了します。
2. プロジェクトに [Workato スコープ] アクティビティを追加します。
3. [ Workato スコープ] アクティビティ内に [レシピを取得 ] アクティビティを追加します。
4. [レシピ ID] プロパティの String または String 変数を作成し、入力します。
5. [出力 ] セクションのプロパティのために Recipe 型変数を作成し、入力します。
6. [出力 ] セクションのプロパティのために ResponseStatus 型変数を作成し、入力します。

アクティビティの本体

• 検索 - [検索 ] ボタンを クリックして、設計時に レシピ を検索および検索できます。このボタンをクリックすると、特定のレシピを検索して検索できるダイアログが呼び出されます。
• レシピ ID - 詳細の取得に使用するレシピの ID です。 String または String 型変数を入力します。

プロパティ

共通

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

その他

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

出力

• レシピ - 指定したレシピの詳細です。 Recipe 型変数を入力します。このプロパティ用に作成した変数は、後続のアクティビティ ( [レシピを開始]、[ レシピを停止] など) で入力変数として使用できます。 Recipe オブジェクトには、他のアクティビティで使用できる複数のプロパティが含まれます。これらのプロパティのリストについては、Workato API の応答 の例をご覧ください。
• 応答ステータス - 要求のステータスです (成功/失敗に関する情報)。 ResponseStatus 型変数を入力します (UiPath.BAF.Models.ResponseStatus)。 ResponseStatus オブジェクトには、他のアクティビティで使用できる 3 つのプロパティが含まれています。
  • Success - Boolean - API 要求が成功したかどうかを示します。
  • ErrorCode - String - API 要求が成功しなかった場合の応答エラーです (Success=False)。
  • Message - String - エラー メッセージです。