Get File Lock Info

UiPath.Box.Activities.File.GetFileLockInfo

The Get File Lock Info activity uses the Box Get file information API to the lock information for a specified file (File ID).

After retrieving the lock information, the activity outputs a BoxFileLock (File Lock) object that includes the lock properties.

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 Lock Info activity inside the Box Scope activity.
5. Enter a value for the Input property.
6. Create and enter a BoxFileLock variable for the Output property.
   • Your input property values are sent in the Get file information API operation request.
   • The operation returns the BoxFileLock value to your output property variable.
     
     

     

     
     

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. 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 Lock - A BoxFileLock object that includes the file lock information. Enter a BoxFileLock variable. The BoxFileLock object includes multiple properties that you can use in other activities.