Lock File

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

     

     
     

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 lock. 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.

Options

• Expires At - The date when the lock expires. Enter a DateTime or DateTime variable. Default is to never expire.
• Prevent Download - If selected, the file can't be downloaded.

Output

• File Lock - A Boolean value that reports the current file lock status. The Boolean values are:
  • True - file is locked.
  • False - file is unlocked.