Subscribe

UiPath Activities

The UiPath Activities Guide

Get Record

UiPath.MicrosoftDynamics.Activities.GetRecord

The Get Record activity uses the Web API GET operation to retrieve a record.

After retrieving the record, the activity outputs the status of the request (success/failure information) in a ResponseStatus object (MicrosoftDynamicsStatus) that you can use in subsequent activities (e.g., conditional logic).

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 an activity or run an external process that outputs the record identifier (e.g., Insert Record, Search Records).
  4. Add the Get Record activity inside the Microsoft Dynamics Application Scope activity.
  5. Click the Configure button inside the Get Record activity (this opens the Object Wizard).
  6. Select the Object you want to retrieve, enter the record identifier, and add the fields (with values) that you want to populate.
  7. Create and enter a ResponseStatus variable for the Output property.
    • Your input property values are sent in the POST operation request.
    • The operation returns the ResponseStatus and value to your output property variable.

Configure

To enter your Get Record property values, you must use the Object Wizard by clicking the Configure button.

When you select an Object using the Object Wizard, you can add the fields that you want to include in the request. For a complete list of the available fields for each object, see the Web API EntityType Reference in the Microsoft documentation.

To learn more about the Object Wizard, see the Business Activity Frameworks page.

Properties

Advanced

  • AdditionalFields - A DataRow that includes the columns and values that you want to insert. Enter a DataRow variable.
    • To determine/validate your DataRow column names, click the Configure button, select your Object, and review the names shown in the Field column; your DataRow column names must match the shown value.
    • If you enter a value for a field in both the Object Wizard and the AdditionalFields property, the value entered in the Object Wizard takes precedent (overwriting the AdditionalFields value).

Common

  • DisplayName - The display name of the activity. This field supports only Strings or String variables.

Misc

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

Output

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

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 3 months ago


Get Record


Suggested Edits are limited on API Reference Pages

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