エンティティ レコードにクエリを実行

UiPath.DataService.Activities.QueryEntityRecords<UiPath.DataService.Definition.IEntity>

説明

選択されたエンティティに対し、指定されたフィルターに従ってレコードのリストを UiPath Data Service から取得します。

プロジェクトの対応 OS

Windows - レガシ | Windows | クロスプラットフォーム

Windows、クロスプラットフォームでの設定

• エンティティ - アクティビティで使用するエンティティを選択します。このプロパティは、Data Service からインポートされたエンティティのみをサポートします。

• クエリ - エンティティを選択すると、クエリを設定するようウィザードで求められます。

  フィルター ビルダーでは次の手順を行います。

  1. [条件を追加] または [グループを追加] をクリックします。最初のドロップダウン メニューで、選択されたエンティティ型をフィルター処理するときの基準となるフィールドを選択します。関連する任意のエンティティのフィールドを選択することもできます。

  2. 2 つ目のドロップダウン メニューで、選択されたフィールドを評価するための演算子を選択します。演算子のリストは、最初のドロップダウン メニューで選択されたフィールドの型によって変化します。

  3. 3 つ目の式フィールドには、選択されたフィールドに対する値または式を入力します。サポートされる値は、最初のドロップダウン メニューで選択されたフィールドの型によって変化します。

  4. 他の条件またはグループを追加する場合は [条件を追加] をクリックし、[すべて] または [いずれか] のどちらの条件を使用してフィルター処理するかを選択します。

詳細オプション

オプション

• 並べ替えフィールド - 取得したレコードを並べ替える基準となるフィールドの名前です。この名前は、大文字と小文字の区別も含め、選択したエンティティの型の有効なフィールド名と同一である必要があります。既定では、このフィールドは [Id] に設定されます。

• 昇順で並べ替え - [並べ替え] プロパティで指定したフィールドに基づいて、レコードを昇順に並べ替えます。このフィールドは Boolean 値 (True、False) のみをサポートします。既定値は True です。

• 上限 - すべてのレコードのうち、取得するレコードの最大数を指定します。このプロパティは 1 から 1000 までの値をサポートしています。このフィールドの既定値は 100 です。

• スキップ - 指定した件数だけレコードをスキップできます。指定された値がレコードの合計数より大きい場合、レコードは取得されません。このプロパティは、0 以上の値をサポートし、既定では、0 に設定されます。

• Target.Timeout (milliseconds) - エラーがスローされるまでにアクティビティが待機する時間 (単位: ミリ秒) を指定します。既定値は、30000 ミリ秒 (30 秒) です。

• 関連レコードの深さ - サービスから取得する関連レコードの深さを指定します。このプロパティは 1 から 3 までの値をサポートします。既定値は 2 です。

出力

• レコードの合計数 - 指定したクエリ フィルターに一致するレコードの合計数であり、Int64 型の変数に格納されます。このフィールドは Int64 型変数のみをサポートします。

• 出力レコード - Data Service から取得したレコードのリストです。このフィールドは、Data Service からインポートされる型の List オブジェクトのみをサポートし、選択されたエンティティの型と同じ型である必要があります。

Windows - レガシでの設定

プロパティ パネル

共通

• エラー発生時に実行を継続 - アクティビティが例外をスローした場合でも、ワークフローを継続するかどうかを指定します。このフィールドでは Boolean 値 (True、False) のみサポートされています。既定値は False です。その結果、フィールドが空白で例外がスローされると、プロジェクトの実行が停止します。値を True に設定すると、プロジェクトの実行はエラーに関係なく継続されます。

  注: このアクティビティが [トライ キャッチ] に含まれていて、[エラー発生時に実行を継続] プロパティの値が True の場合、プロジェクトが実行されたときにエラーは発生しません。
• 表示名 - アクティビティの表示名です。
• Target.Timeout (milliseconds) - エラーがスローされるまでにアクティビティが待機する時間 (単位: ミリ秒) を指定します。既定値は、30000 ミリ秒 (30 秒) です。

その他

• プライベート - オンにした場合、変数および引数の値が Verbose レベルでログに出力されなくなります。
• TypeArgument - アクティビティで使用するエンティティの型です。このプロパティは Data Service からインポートした型のみをサポートします。このプロパティは、アクティビティの本体では [Entity Type] と呼ばれます。既定では、UiPath.DataService.Definition.IEntity が選択されています。

オプション

• 関連レコードの深さ - サービスから取得する関連レコードの深さを指定します。このプロパティは 1 から 3 までの値をサポートします。既定値は 2 です。
• 昇順で並べ替え - [並べ替え] プロパティで指定したフィールドに基づいて、レコードを昇順に並べ替えます。このフィールドは Boolean 値 (True、False) のみをサポートします。既定値は True です。
• 並べ替えフィールド - 取得したレコードを並べ替える基準となるフィールドの名前です。この名前は、大文字と小文字の区別も含め、選択したエンティティの型の有効なフィールド名と同一である必要があります。既定では、このフィールドは Id に設定されます。

出力

• 出力レコード - Data Service から取得するレコードのリストです。このフィールドは、Data Service からインポートされる型の List オブジェクトのみをサポートし、選択されたエンティティの型と同じ型である必要があります。

ページネーション

• スキップ - 指定した件数だけレコードをスキップできます。指定された値がレコードの合計数より大きい場合、レコードは取得されません。このプロパティは、0 以上の値をサポートし、既定では、0 に設定されます。
• 上限 - すべてのレコードのうち、取得するレコードの最大数を指定します。このプロパティは 1 から 1000 までの値をサポートしています。このフィールドの既定値は 100 です。
• レコードの合計数 - 指定したクエリ フィルターに一致するレコードの合計数であり、Int64 型の変数に格納されます。このフィールドは Int64 型変数のみをサポートします。

デザイナー パネル

• エンティティの型 - このアクティビティで使用するエンティティの型を選択します。このプロパティは Data Service からインポートした型のみをサポートします。既定では UiPath.DataService.Definition.IEntity が選択されます。

• クエリ - [クエリ ビルダーを開く] ボタンをクリックして、選択されたエンティティ型に対するフィルターを設定し、Data Service からレコードを取得します。

  [クエリ ビルダー] ウィンドウで、次の手順を実行します。

  • 最初のドロップダウン メニューで、選択されたエンティティ型をフィルター処理するときの基準となるフィールドを選択します。関連する任意のエンティティのフィールドを選択することもできます。
  • 2 つ目のドロップダウン メニューで、選択されたフィールドを評価するための演算子を選択します。演算子のリストは、最初のドロップダウン メニューで選択されたフィールドの型によって変化します。
  • 3 つ目の式フィールドには、選択されたフィールドに対する値または式を入力します。サポートされる値は、最初のドロップダウン メニューで選択されたフィールドの型によって変化します。

  • 他の条件またはグループを追加する場合は [追加] をクリックし、[すべて] または [いずれか] のどちらの条件を使用してフィルター処理するかを選択します。

    
    

    

    
    
• 出力レコード - Data Service から取得するレコードのリストです。このフィールドは、Data Service からインポートされる型の List オブジェクトのみをサポートし、選択されたエンティティの型と同じ型である必要があります。