UiPath Integrations

The UiPath Integrations Guide

Welcome to the UiPath Integrations guide. You will find comprehensive guides and documentation to help you start working with UiPath Integrations, as well as support if you get stuck.

In order to download the solutions mentioned here please visit the official UiPath Go! Marketplace here.

*Note that only integrations built in-house at UiPath are detailed below. For a complete list of UiPath's technology partners, see here.

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.

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

Common

DisplayName

The display name of the activity.

Attributes
Details

Type

String

Required

Yes

Default value

Searc Records

Allowed values

Enter a String or String variable.

Notes

N/A


Options

QueryOptions

The search parameters that you want to use to retrieve your records.

Attributes
Details

Type

Dictionary<String, String>

Required

No

Default value

Empty

Allowed values

Enter a Dictionary<String, String> or Dictionary<String, String> variable.

Notes

  • 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.

Steps to create a Dictionary<String, String> variable

The following is one way to populate a Dictionary<String, String> variable:

  1. Install the Microsoft.Activities.Extensions package.
  2. Create a new Dictionary<String, String> variable (e.g., queryOption).
  3. 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'")
  4. Repeat step 3 to apply additional QueryOptions.

Object wizard

Select an Object using the Object Wizard.

Misc

Private

If selected, the values of variables and arguments are no longer logged at Verbose level.

Attributes
Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


Output

MicrosoftDynamicsStatus

The status of the request (success/failure information).

Attributes
Details

Type

ResponseStatus

Required

No (required if you want to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a ResponseStatus variable.

UiPath.BAF.Models.ResponseStatus

Notes

  • 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.
  • The example image below shows some of the properties that you can return.

Result

The records that match your search parameters.

Attributes
Details

Type

DataTable

Required

No (required if you want to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a DataTable variable.

Notes

N/A


Example

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.

Updated about a month ago


Search Records


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.