Get File/Folder

UiPath.MicrosoftOffice365.Activities.Files.GetItem

Description

Uses the Microsoft Graph Get item API to get the metadata of a specified item with a known ID (ItemID). To get the ID of the item, you can use an activity that outputs a DriveItem object (e.g., Find Files And Folders).

After locating the item, the activity returns its metadata in a new DriveItem object (Item) that you can use in subsequent activities.

Scopes

This activity requires the following scopes:

• Sites.Read.All

OR

• Sites.ReadWrite.All

Project compatibility

Windows - Legacy | Windows

Configuration

In the Body of the Activity

• File or folder - The target file or folder. Click Browse next to the field, and then browse to and select the folder or file. 
• Enter Id - To get the ID, enter an output DriveItem variable from an activity dependency (e.g., Find Files And Folders, Copy File/Folder, Create Folder). When entering the DriveItem variable, get the object's ID by appending ".Id" to the end of the variable (e.g., firstFolderFound.Id). This property supports String variables and string formatted values.
• Enter URL - The DriveItem Url of the file or folder of interest. This property supports String variables and string formatted values.

Properties Panel

Common

• DisplayName - The display name of the activity in the Designer panel. This property supports String variables and string formatted values.

Input

• Item ID - The DriveItem ID of the file or folder of interest. This property supports String variables and string formatted values.
• Item Url - The DriveItem Url of the file or folder of interest. This property supports String variables and string formatted values.

Misc

• Private - If selected, the values of variables and arguments are no longer logged at Verbose level. This field supports Boolean values.

Options

• Account - The ID or User Principal Name for the user who owns the OneDrive. This parameter must be set for ApplicationIdAndSecret and ApplicationIdAndCertificate authentication types.

Output

• Item - The file or folder of interest as a DriveItem.

Sharepoint

• Drive name - The name of the drive within OneDrive or SharePoint searched for the indicated files or folders. If this drive exists within SharePoint, Site Url must be specified. If left empty, the search is carried out in the default drive (typically "Documents") of the SharePoint site specified in the Site Url field. This property supports String variables and string formatted values.
• Site Url - The URL of the SharePoint site searched for the indicated files or folders. Required only when searching in SharePoint. 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 Drive Name would be "Documents". This property supports String variables and string formatted values.

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 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, Create Workbook, Copy File/Folder).
4. Add the Get Item Info activity inside the Microsoft Office 365 Scope activity.
5. Enter values for the Input properties.
6. Create and enter a DriveItem variable for your Output property.

7. Run the activity.

   • Your input property values are sent to the GetItem API.
   • The API returns the DriveItem value to your output property variable.