Using the WHERE property in LIST activities

Overview

UiPath uses a generic pattern for activities such as List Records and List All Records in the activity packs compatible with the new Integration Service.

Note: More information on establishing a connection using the Integration Service is available in our Connections guide. Once this connection is successfully established, you can use it in your UiPath Studio project.

1. Add a Scope activity to your project and click on the Configure button. Your connection should be detected automatically. Click the Save button.

2. Add a List activity inside the Scope and click the Configure button.

3. Select the Object from the drop-down menu.

   Each object displays different properties, but in most situations you will encounter some common ones, such as the Object name, the Where expression or Fields selection. Below you can find some of the generic properties you may find in List activities.

   
   
   
   • Dir - Choose one of the available options for this field: ascending or descending.
   • Id - The ID of the object.
   • Fields - The fields to return on the response. Can be a single field or a comma-separated list of fields.
   • Order_by - The manner in which the objects will be ordered.
   • Page Token - Taken from the next page token of the previous page.
   • PageSize - The number of resources to return in a given page.
   • Where - The CEQL search expression, or customize the where clause, without the WHERE keyword, in a typical SQL query.
   • Max Records - Encountered in List All Records activities. It defines the maximum number of records to return.
   • Next Page Token - Encountered in List Records activities. It represents the token for the next page of records. Use this token to iterate through pages until an empty list is returned.

The WHERE property

The Where property, or the CEQL search expression, provides a standard way to search across our connectors. It is a portion of a typical activity that can include a number of properties.

The Where property specifies what to search and what objects to return in our result set. It is made up of a left­ hand ­side (LHS), an operator and a right­ hand­ side (RHS). Scroll down to see a list of Valid CEQL Operators.

Valid Operators

Below you will find a list of operators you can use inside the Where property:

• AND - TRUE if all the conditions separated are TRUE
• OR - TRUE if any of the conditions separated are TRUE
• = - Equal to
• != - Not equal to
• < - Less than
• > - Greater than
• <= - Less than or equal to
• >= - Greater than or equal to
• LIKE - TRUE if the operand matches a pattern
• IN - TRUE if the operand is equal to one of a list of expressions
• IS NULL - TRUE if a NULL value is found
• LIMIT - Limit the number of records to the specified number