UiPath Documentation
activities
latest
false
Workflow activities

Query Entity Records

Retrieves a list of records for the selected entity from UiPath Data Fabric, according to specified filters.

Description

Retrieves a list of records for the selected entity from UiPath Data Fabric, according to specified filters.

This activity is equivalent to the activity of the same name in the Data Service classic activities package.

Project compatibility

Windows | Cross-platform

Supported workflows

All workflows except RPA (neither Studio Desktop, nor Studio Web).

Properties

  • UiPath Data Fabric connection - Select the Data Fabric connection you established in Integration Service. Access the dropdown menu to select, add, or manage connections.
  • Entity - Select an entity to use with this activity. This dropdown menu includes your Data Fabric entities. Depending on the object chosen in this field, the activity is populated with property fields specific to that object. This field supports TypeArgument for ImportedEntities type input.
    • If you Switch to object view, you must provide a single consolidated object with the value of every field in it.
  • Query - Using the filter builder, add a query to filter entity records

The Filter Builder provides a set of operators that you can use to filter records based on the values of entity fields. The operators available for a field depend on its data type.

The following table describes each supported operator and the data types it applies to.

For the In and Not In operators, enter values as a comma-separated list. For example, to return only records where the text field productName in the Product entity is Computer or Laptop, enter Computer,Laptop.

OperatorDescriptionApplicable data types
Equals (=)Matches records where the field value is exactly equal to the specified value.Text, Number, Yes/No, Date-Time, ChoiceSet
Not Equals (!=)Matches records where the field value is not equal to the specified value.Text, Number, Yes/No, Date-Time, ChoiceSet
Less Than (<)Matches records where the field value is less than the specified value. For date fields, this returns records with an earlier date or time.Number, Date-Time
Less Than Or Equal (<=)Matches records where the field value is less than or equal to the specified value.Number, Date-Time
Greater Than (>)Matches records where the field value is greater than the specified value. For date fields, this returns records with a later date or time.Number, Date-Time
Greater Than Or Equal (>=)Matches records where the field value is greater than or equal to the specified value.Number, Date-Time
ContainsMatches records where the field value contains the specified text as a substring.Text
Not ContainsMatches records where the field value does not contain the specified text.Text
Starts WithMatches records where the field value begins with the specified text.Text
Ends WithMatches records where the field value ends with the specified text.Text
InMatches records where the field value is equal to any value in a specified list.Text, Number, Date-Time, ChoiceSet
Not InMatches records where the field value is not equal to any value in the specified list.Text, Number, Date-Time, ChoiceSet
Is NullMatches records where the field value is null. This operator does not require an input value.Text, Number, Yes/No, Date-Time, ChoiceSet
Is Not NullMatches records where the field contains a non-null value. This operator does not require an input value.Text, Number, Yes/No, Date-Time, ChoiceSet
Is TrueMatches records where a Yes/No field is True. This operator does not require an input value.Yes/No
Is FalseMatches records where a Yes/No field is False. This operator does not require an input value.Yes/No

Options

  • Skip - Specify the number of records to skip from the start.
  • Top - Specify number of records to return at most. The property supports values from 1 to 1000. The default value is 100.
  • Sort ascending - Specify whether to sort in ascending (true) or descending (false) order.
  • Sort by field - Specify the field used to sort the returned records.
  • Related Record depth - Specify the depth of related records in the response from the service. Range: 1-3. Default: 3.

Output

  • Query Entity Records — Returns a list of records from the selected entity that match the provided filter. Each record includes all fields the caller has access to.
  • Description
  • Project compatibility
  • Supported workflows
  • Properties
  • Options
  • Output

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated