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.

Find Files And Folders

Overview

The Find Files and Folders activity uses the Microsoft Graph SearchItems API to find the files, metadata, and/or contents that match the values of your search parameters (Query). By default, this activity searches your connected OneDrive. You have the option to change your search location to a SharePoint site (DriveName and SiteURL).

After performing the search, the activity returns the matching DriveItem objects (First and Results) that you can use as input variables in subsequent activities; almost all of the Excel and Files activities require this as an input variable.

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 the Find Files And Folders activity inside the Microsoft Teams Scope activity.
  4. Enter values for the Input properties.
  5. Create and enter a DriveItem and DriveItem[] variables for the Output properties.
  6. Run the activity.
    • Your input property values are sent to the SearchItems API.
    • The API returns the DriveItem and DriveItem[] values to your output property variable.

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

Find Files and Folders

Allowed values

Enter a String or String variable.

Notes

N/A


Input

Query

Your search parameters (e.g., file name, content keywords).

Attributes
Details

Type

String

Required

No

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

  • If left empty, the contents of the root folder are returned (max results 200).
  • For a complete list of the supported query parameters, see the drive item Properties in the Microsoft API documentation.

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


Sharepoint

DriveName

The name of the drive in your specified SiteURL that you want to search.

Attributes
Details

Type

String

Required

No

Default value

Empty

Allowed values

Enter a String or String variable

Notes

  • If left empty, the search is carried out in the default drive (typically "Documents") of the SharePoint site specified in SiteUrl field.

SiteURL

The root URL of the SharePoint site where the DriveName is located.

Attributes
Details

Type

String

Required

Yes (only when searching in SharePoint)

Default value

Empty

Allowed values

Enter a String or String variable

Notes

  • As an example, if you want to search in your SharePoint site's documents, your site URL could be "https://uipath.sharepoint.com/sites/Quickstart" and your DriveName would be "Documents" (see Option 2 in the example image below).

Output

First

The first file or folder found with a name or content that matches your Query value.

Attributes
Details

Type

DriveItem

Required

No (recommended if you plan to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a DriveItem variable.

Notes

  • The DriveItem contains information about the file including its name, size, type, etc., that you can use in subsequent activities.

Results

All files and folders found with a name or content that matches your Query value.

Attributes
Details

Type

DriveItem[]

Required

No (recommended if you plan to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a DriveItem[] variable.

Notes

  • When using the Results DriveItem variable in other activities, specify the item in the array that you want to use (e.g., myFiles(0)).
  • The DriveItem contains information about the file including its name, size, type, etc., that you can use in subsequent activities.

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


Find Files And Folders


Suggested Edits are limited on API Reference Pages

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