Subscribe

The UiPath Marketplace Guide

Download File

The Download File activity uses the the Oracle NetSuite File API to Download a file (File) to a specific folder (LocalFolderPath).

After Downloading the file, the activity outputs the status of the Download (success/failure information) in a ResponseStatus object (ResponseStatus). This output can be used as an input variable in subsequent activities (e.g., ResponseStatus in 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 Oracle NetSuite Scope activity to your project.
  3. Add the Download File activity inside the Oracle NetSuite Scope activity.
  4. Create and enter a String and a FileId variable for the Input properties.
  5. Create and enter a String and a Folder variable for the Input properties.
  6. Create and enter a String and a ResponseStatus variable for the Output properties.

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

Download File

Allowed values

Enter a String or String variable.

Notes

N/A


Input

FileId

The Id of the file you want to Download.

Attributes

Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

N/A

Folder

The full path to the folder to Download your file to.

Attributes

Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

N/A


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

ResponseStatus

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.


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


Download File


Suggested Edits are limited on API Reference Pages

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