Box File Operations
This Snap performs move, copy, and delete operations in Box.
Write-type Snap-
Works in Ultra Tasks
Snap Views
| Type | Description | Examples of upstream and downstream Snaps |
|---|---|---|
| Input | This Snap has at most one document input view. | |
| Output | This Snap has exactly one document output view. | |
| Learn more about Error handling. | ||
Snap settings
Note:
Learn about the common controls in the Snap settings dialog.
| Field/Field set | Description |
|---|---|
|
Label String
|
Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline. |
|
Box operations Dropdown list
|
Required. The operation in Box to perform. The options
available include:
If Copy or Move is selected, Destination ID is mandatory. If Delete is selected, Destination ID and New name are not applicable. Default value: Move Example: Copy |
|
Source type Dropdown list
|
Required. The type of item to be moved. Can be a
file or folder. Default value: File Example: File |
|
Source ID String
|
Required. The ID of the item you wish to move. If the
target is a folder, this will be the folder ID. If the target is a file, this will
be the file ID. Example: 1234 |
|
New name String
|
The item will be renamed to this in its new destination. This is an optional
property. Example: new_file |
|
Destination ID String
|
Required. The folder ID of the folder to which the item
will be moved. Example: 34567 |
|
Number of retries Integer
|
Enter the integer value to specify the number of attempts the Snap makes to
perform the selected operation in case of connection failure or timeout. Minimum value: 0 Default value: 3 Example: 3 |
|
Retry interval (seconds) Integer
|
Enter the time interval in seconds between retry attempts. Minimum value: 1 Default value: 5 Example: 4 |
|
Snap execution Dropdown list
|
Choose one of the three modes in
which the Snap executes. Available options are:
Default value: Execute only |