レシピ リストの表示

ユーザーに属するアクティブまたは非アクティブな Workato レシピのリストを取得するアクティビティです。任意でアダプター名と順序でフィルター処理

UiPath.Workato.Activities.ListRecipes

[レシピのリストを取得] アクティビティは、ユーザー API に属する Workato の List recipes を使用して、[ Workato スコープ] アクティビティに指定したユーザーに属するアクティブまたは非アクティブなレシピ ( Active) のリストを取得します。このアクティビティでは、フィルター条件で結果を絞り込むこともできます。

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

動作のしくみ

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

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

アクティビティの本体

[リストのレシピ] のプロパティ値を入力するには、[設定] ボタンをクリックしてオブジェクト ウィザードを使用する必要があります。

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

• アクティブ - オンにすると、アクティビティはアクティブな (実行中の) レシピのみを返します。
• アダプタ名 - 取得するレシピに含まれるアダプタ名 (アプリケーション) のカンマ区切りリスト。アクションアプリケーションの正確な名前 (大文字と小文字を区別) を入力します。たとえば、Google ドライブ アプリケーションを含むレシピのリストを取得する場合は、「 google_drive」と入力します。
  • 正確な名前を見つける方法の 1 つは、アクティビティの [ テスト検索 ] ボタンを使用することです (以下の例を参照)。入力した名前が見つからない場合、他のパラメーターに従ってレシピが返されます (つまり、このプロパティに値を入力しなかったかのように動作します)。
• 順序 - 順序付け方法を設定します。[アクティビティ] と [既定] の 2 つのオプションがあります。
• SearchAll - [AdapterNames ] プロパティに入力された名前のリストを検索に適用する方法を指定します。オンにすると、AdapterNames プロパティに一覧表示されているすべてのアダプターを含むレシピのみが返されます。選択しない場合、アクティビティは、AdapterNames プロパティにリストされているアダプターを少なくとも 1 つ含むレシピを返します。
• SinceId - 取得するレシピ ID の最も高い値を指定します。Int32変数またはInt32値を入力します。このアクティビティは、このプロパティで指定した値よりも小さい ID のレシピを返します。
  注:

  オブジェクト ウィザードの [サンプル値] 列に値を入力すると、[テスト] ボタンを使用して、それらのフィルターが設計時に結果にどのように影響するかを確認できます。

プロパティ

共通

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

その他

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

出力

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