Classic Integrations Activities
Last updated Jul 17, 2024

Search Records


Using your search parameters (QueryOptions and Object), the Search Records activity uses the Web API GET operation to retrieve records.

After retrieving the records, the activity outputs the results in a DataTable object (Result) and the status of the request (success/failure information) in a ResponseStatus object (MicrosoftDynamicsStatus), both of which you can use in subsequent activities (e.g., conditional logic, Update Record, Download Activity Attachment, etc.).

How it works

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Microsoft Dynamics Application Scope activity to your project.
  3. Add the Search Records activity inside the Microsoft Dynamics Application Scope activity.
  4. Select the Object you want to retrieve and enter your search parameters in the Options property.
  5. Create and enter a DataTable and a ResponseStatus variable for the Output properties.
    • Your input property values are sent in the GET operation request.
    • The operation returns the DataTable and ResponseStatus values to your output property variables.

In the Body of the Activity

  • Object - Select an Object using the Object Wizard.


  • DisplayName - The display name of the activity. This field supports only strings or String variables.
  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
  • QueryOptions - The search parameters that you want to use to retrieve your records. Enter a Dictionary<String, String> or Dictionary<String, String> variable. For more information about query values, see the query metadata and/or query data pages in the Microsoft documentation. See the steps below for one way to create and populate a Dictionary<String, String> variable.
    The following is one way to populate a Dictionary<String, String> variable:
    • Install the Microsoft.Activities.Extensions package.
    • Create a new Dictionary<String, String> variable (e.g., queryOption).
    • Add an Add to dictionary activity.
    • Enter your Dictionary variable (e.g., queryOption)
    • Enter a single query method into the Key property (e.g., "$filter", "$select", etc.)
    • Enter the Value to apply to the query method (e.g., "name eq 'Quickstart_Account'")

      • Repeat step 3 to apply additional QueryOptions.
  • ResponseStatus - The status of the request (success/failure information). Enter a ResponseStatus variable (UiPath.BAF.Models.ResponseStatus). The ResponseStatus object includes three properties that you can use in other activities.
    • Success - Boolean - Specifies whether the API request was successful.
    • ErrorCode - String - The response error if the API request is unsuccessful (Success=False).
    • Message - String - The error message.
  • Result - The records that match your search parameters. Enter a DataTable variable.


The following image shows an example of the activity dependency relationship and input/output property values.

For step-by-step instructions and examples, see the Quickstart guide.

  • How it works
  • In the Body of the Activity
  • Properties
  • Example

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.