Query Multiple Entity Records

Sends a request to the Data Fabric API to query records from a primary entity, with optional expansion to a secondary entity via a field-level filter.

Description

Sends a request to the Data Fabric API to query records from a primary entity, with optional expansion to a secondary entity via a field-level filter.

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 in Studio Desktop and 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.
• Primary entity - Specify the main entity from which records are retrieved.
• Secondary entity - Specify the related entity to join with the primary entity.
• Join type - Define the type of join performed between the primary and secondary entities.
  • Inner Join - Select to return only records where matching values exist in both entities.
  • Left Join - Select to return all records from the primary entity and matching records from the secondary entity. If no match exists, secondary fields return null.
• Primary entity join field - Specify the field from the primary entity used to establish the join relationship.
• Secondary entity join field - Specify the field from the secondary entity used to establish the join relationship.
• Filter conditions - Define filtering criteria for records from the primary and/or secondary entity. The filter builder works like the one in Query Entity Records, and field names are drawn from both the primary and secondary entities.

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. Field names are prefixed with the entity name — for example, the Name field in the Student entity appears as Student_Name, and relationship fields use the dotted notation from Query Entity Records. To return only records where Student_Name is John or Jane, enter John,Jane.

Operator	Description	Applicable 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
Contains	Matches records where the field value contains the specified text as a substring.	Text
Not Contains	Matches records where the field value does not contain the specified text.	Text
Starts With	Matches records where the field value begins with the specified text.	Text
Ends With	Matches records where the field value ends with the specified text.	Text
In	Matches records where the field value is equal to any value in a specified list.	Text, Number, Date-Time, ChoiceSet
Not In	Matches records where the field value is not equal to any value in the specified list.	Text, Number, Date-Time, ChoiceSet
Is Null	Matches records where the field value is null. This operator does not require an input value.	Text, Number, Yes/No, Date-Time, ChoiceSet
Is Not Null	Matches 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 True	Matches records where a Yes/No field is True. This operator does not require an input value.	Yes/No
Is False	Matches 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.

Output

• Query Multiple Entity Records — Returns a list of records produced by joining the two selected entities and applying the provided filter. Each record contains all fields the caller has access to across both entities.