Subscribe

UiPath Activities

The UiPath Activities Guide

Download File from Record Field

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

Description

Downloads a file from a specified file of an entity record.

📘

Note:

No output is returned if no file is available in the specified entity record.

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 - Id for the record from Data Service for the selected Entity type to download the file.

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.

To

  • File Path - The full local path where you want to download the file. Relative paths are resolved based on the runtime execution directory. If no value is provided, the file will be downloaded in the current execution directory with the stored name.

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.
  • Field - The field to download the file for a record. This property only supports fields of type File from Data Service.
  • File Path -The full local path where you want to download the file. Relative paths are resolved based on the runtime execution directory. If no value is provided, the file will be downloaded in the current execution directory with the stored name.

Updated about a month ago


Download File from Record Field


Suggested Edits are limited on API Reference Pages

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