Get File or Folder List

UiPath.MicrosoftOffice365.Activities.Files.GetFileListConnections

Description

Retrieves a list of files or folders from a specified OneDrive or SharePoint location.

Scopes

This activity requires the following scopes:

• Files.Read

OR

• Files.ReadWrite

OR

• Files.Read.All

OR

• Files.ReadWrite.All

OR

• Sites.Read.All

OR

• Sites.ReadWrite.All

Project compatibility

Windows | Cross-platform

Configuration

• Microsoft OneDrive & SharePoint connection - The connection for the Microsoft 365 account to use in the activity.
• In location - The location where to search for files and folders. The method to specify the file or folder to be retrieved: Enter Id, Enter Url, Relative path, or Use variable.
  • Folder picker option - Browse the OneDrive or SharePoint folders and select a file or folder. This field accepts IResource input.
  • Relative path option:
    • Parent folder - Specify the parent folder. Browse the OneDrive or SharePoint folders and select a file or folder. This field accepts IResource input.
    • Relative file or folder path - Specify the relative file or folder path to the parent folder, including the name and extension. This field accepts String input.

  • Enter Id option:

    • File or folder Id - The ID of the file or folder. To retrieve the ID, open the file in OneDrive Web and retrieve its URL. The ID is encoded in the URL. For example: if the URL is https://yourcompany.sharepoint.com/Doc.aspx?sourcedoc=%7BA1CA7E78-BA59-4DD4-A6B9-5F5BBC37FA85%7D&file=Merge_sheets.xlsx`, the decoded file ID is A1CA7E78-BA59-4DD4-A6B9-5F5BBC37FA85. %7B and %7D are the delimiters around the file ID. This field supports String type input.
    • SharePoint site address - The URL of the SharePoint site that contains the file or folder. Open your SharePoint site in a browser and retrieve the URL, e.g., https://yourCompany.sharepoint.com/sites/Marketing. This property supports String type input.
    • SharePoint document library - The document library within the indicated SharePoint site that contains the file or folder. Open your SharePoint site in a browser, go to the Documents tab, then retrieve the URL, e.g., https://yourCompany.sharepoint.com/sites/Marketing/Shared%20Documents/Forms/AllItems.aspx. This property supports String type input.

  • Enter Url option:

    • File or folder Url - The URL of the file or folder. This property supports String variables and string formatted values. Retrieve the URL by opening the file in a browser.

  • Use the See more button menu to use a variable or select the Reload Folder Data option if you've modified your folders and need to retrieve the latest data.

Additional options

Options

• Limit to first - The maximum number of files and folder to return. If left blank, there is no limit. This field supports Int32 variables and Int32 values.
• What to return - Specifies what to return. Choose one of the available options from the dropdown menu:
  • Files - Retrieve files.
  • Files and folders - Retrieve files and folders ordered by name.
  • Folders - Retrieve folders.
• Trim duplicates - Boolean value. Set to True to remove duplicate files and folders from the search results.
• Simple search - The query text used to search for files and folders across several fields (such as file name or file content). This property supports String variables and string formatted values. Use the See more button menu to switch to Advanced search, Free Text Filter, or Metadata search.

• Advanced search - An advanced search criteria defined to filter the files and folders. This advanced search is not supported for personal Microsoft accounts. Advanced search uses the Filter builder to configure the search criteria.

  • Include subfolders - Boolean value. Set to True to expand the search to all subfolders in the selected location.
    Note: Filtering by File extension in the Filter builder might not work for extensions such as .avi, .svg, .gif, .ico, .jpeg, .jpg, .mov, .mp3, .mp4, .ogg, .png, .rtf, .tiff, .wav, .webm, .webp, or .wmv. Filtering by Last modified by or Shared with user might return incomplete results.
• Free text filter - Search for a list of files or folder by a free text. This field supports String type input.
• Metadata filter - Filter by item metadata. This field is dynamically populated if you select a SharePoint document library for the In location field.

Output

• Files or folder - The list of files retrieved by the activity. Automatically generated output variable. You can use it as it is or save it with a different name. You can use this in other activities.

Example

See also:

• Files activities

• For Each File/Folder
• Move File/Folder
• Copy File/Folder