Skip to main content

Get File Info

UiPath.Box.Activities.File.GetFileInfo

The Get File Info activity uses the Box Get file information API to retrieve specific file information from a specified file (File Id).

After retrieving the information, the activity outputs the name of the file as a String value (File Name), the locked status as a Boolean value (Is Locked), and the size of the file as in Int64 value` (Size).

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 File.Id value (e.g., Upload File, Search for Content, etc.).
  4. Add the Get File Info activity inside the Box Scope activity.
  5. Enter a value for the Input property.
  6. Create and enter String, Boolean, and Int64 variables for the Output properties.

    • Your input property values are sent in the Get file information API operation request.

    • The operation returns the String, Boolean, and Int64 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​

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

Misc​

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

Output​

  • File Name - The name of the file. This field supports only String variables.
  • File Lock - A Boolean value that reports the current file lock status. Enter a Boolean variable. The Boolean values are:
    • True - file is locked.
    • False - file is unlocked.
  • Size - A Int64 value representing the size of the file.