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.

Download File

Overview

The Download File activity uses the Microsoft Graph DownloadDriveItem API to download a specified file from your OneDrive or SharePoint site (DriveItem) to a local location.

How it works

The following steps and message sequence diagram is an example 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 Office 365 Scope activity to your project.
  3. Add an activity or run an external process that outputs a DriveItem object (e.g., Find Files and Folders).
  4. Add the Download File activity inside the Microsoft Teams Scope activity.
  5. Enter values for the Input properties.
  6. Run the activity.

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

Delete Item

Allowed values

Enter a String or String variable.

Notes

N/A


Input

DriveItem

The file or folder that you want to delete.

Attributes
Details

Type

DriveItem

Required

Yes

Default value

Empty

Allowed values

Enter a DriveItem variable.

Notes

  • Use the output property variable from
    the Find Files and Folders (First or Results) (see example image below).
  • If you're using the Results output property from the Find Files and Folders activity, specify the item in the array that you want to use (e.g., myFiles(0))

LocalFilePath

The local destination where you want to save the downloaded file.

Attributes
Details

Type

String

Required

No

Default value

Empty

Allowed values

Enter a String or String variable

Notes

  • If left empty, the activity saves the file to the directory of the automation project.
  • By default, the file is saved using the file name from OneDrive or SharePoint. If a file with the same name exists in the local path that you enter in this property, the existing file is overwritten.
  • To rename the file (and avoid unwanted overwrites), append the new file name to the end of your local path (e.g., "C:\UiPath_Projects\DownloadExample.docx")

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


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

Updated 3 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.