レシピリストの表示

UiPath.Workato.Activities.ListRecipes

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

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

動作のしくみ

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

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

アクティビティの本体

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

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

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