Subscribe

UiPath Activities

The UiPath Activities Guide

Get Entity Record By Id

UiPath.DataService.Activities.GetEntityRecordById<UiPath.DataService.Definition.IEntity>

Description

Retrieves an existing record for the selected Entity from the UiPath Data Service.

Properties

Common

  • ContinueOnError - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (True, False). The default value is False. As a result, if the field is blank and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.

📘

Note:

If this activity is included in Try Catch and the value of the ContinueOnError property is True, no error is caught when the project is executed.

  • DisplayName - The display name of the activity.
  • Timeout (milliseconds) - Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).

Input

  • Record Id - The ID of the record you want to retrieve from Data Service for the selected Entity Type.

Misc

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
  • TypeArgument - The Entity type you want to use with the activity. The property only supports types imported from Data Service. This property is called Entity Type in the body of the activity. By default, UiPath.DataService.Definition.IEntity is selected.

Options

  • Related Record Depth - Specifies the depth of related records to be retrieved from the service. This property supports values from 1 to 3. The default value is 2.

Output

  • Output Record - The record retrieved from Data Service, stored in an Entity type object. This field only supports objects of types imported from Data Service and must be of the same type as the selected Entity Type.

In the Body of the Activity

  • Entity Type - The Entity type you want to use with the activity. The property only supports types imported from Data Service. By default, UiPath.DataService.Definition.IEntity is selected.

  • Record Id - The ID of the record you want to retrieve from Data Service for the selected Entity Type.

  • Output Record - The record retrieved from Data Service, stored in an Entity type object. This field only supports objects of types imported from Data Service and must be of the same type as the selected Entity Type.

Updated 3 months ago


Get Entity Record By Id


Suggested Edits are limited on API Reference Pages

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