Skip to main content

Get Folder Items

UiPath.Box.Activities.Folder.GetFolderItems

The Get Folder Items activity uses the Box List items in folder API to retrieve the folders and files stored in the specified folder (Folder ID).

After retrieving the items, the activity outputs the file details in an BoxFile[] object (Files) and the folder details in an BoxFolder[] object (Folders).

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 Box Scope activity to your project.
  3. Add an activity or run an external process that outputs a Folder.Id value (e.g., Create Folder, Search for Content, etc.).
  4. Add the Get Folder Items activity inside the Box Scope activity.
  5. Enter a value for the Input property.
  6. Create and enter BoxFile[] and BoxFolder[] variables for the Output properties.

    • Your input property values are sent in the List items in folder API operation request.

    • The operation returns the BoxFiles[] and BoxFolders[] values to your output property variables.

      docs image

Properties​

Common​

  • ContinueOnError - Specifies if you want the activity to continue running when an error is thrown. This field supports only Boolean values.
  • DisplayName - The display name of the activity. This field supports only Strings or String variables.

Input​

  • Folder ID - The ID of the folder that you want to retrieve information from. This field supports only Strings or String variables. To get the Folder ID value, add an activity or run an external process that outputs a File.Id object (e.g., Create Folder, Search for Content, etc.).

Misc​

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

Options​

  • Max Items to Return - The maximum number of results that you want returned. Enter an Int32 or Int32 variable. The maximum number of items that get returned is 1,000.

Output​

  • Files - The IEnumerable<BoxFiles> object that includes the file items. Enter a BoxFiles[] variable.
  • Folders - The IEnumerable<BoxFolder> object that includes the folder items. Enter a BoxFolder[] variable.