Invoke Operations Page
Use the Invoke Operations page in the Adapter Endpoint Configuration Wizard to specify what outbound operation to perform on the files or folders stored on the Box cloud service.
The operations available to you depend on whether you selected the Manage Files and Folders option or the Manage Metadata Instances option on the Invoke Actions page.
File and Folder Operations
If you selected the Manage Files and Folders option, then you can select the following operations.
Element | Description |
---|---|
Get File Info |
Retrieves the details about a file. |
Download File |
Retrieves the actual data of the file. |
Upload File |
Uses the upload API to allow users to add a new file. The Box Adapter automatically uses the appropriate Box API (Upload or Chunk Upload) based on the file size. Files can be handled to the limits of Oracle Integration (1GB). |
Delete File |
Discards a file to the trash.
|
Copy File |
Creates a copy of a file in another folder.
|
Get Folder Info |
Retrieves details for a folder, including the first 100 entries in the folder. To fetch more items within the folder, use the Get Folder Items operation. |
Get Folder Items |
Retrieves all the files, folders, or web links contained within a folder. To request information about the folder itself, like its size, use the Get Folder Info operation. |
Create Folder |
Creates a new folder.
|
Update Folder |
Updates a folder. |
Delete Folder |
Discards a folder to the trash.
|
Get Enterprise Templates |
Retrieves all metadata templates within a user's enterprise. |
Get Shared Link |
Retrieves the shared link for a file or folder.
|
Create or Update Shared Link |
Creates or updates the shared link for a file or folder. |
Apply Watermark on File |
Applies or updates the watermark for a corresponding Box file. |
Apply Watermark on Folder |
Applies or updates the watermark for a corresponding Box folder. |
For details about each operation, see the Box documentation.
Metadata Operations
Box supports the notion of custom metadata that can be attached to files or folders. Box allows you to create metadata templates, which is just another word for business objects.
A metadata template gives you the ability to create any arbitrary business object and then associate that object with file or folder content. For example, you can create a business object with 6 fields, or 10 fields, or whatever it might be. You can then attach that object to a file. With metadata templates, you add value to content management.
If you selected the Manage Metadata Instances option on the Invoke Actions page, then the Invoke Operations page lists the available metadata operations. You can select one of the following operations.
Element | Description |
---|---|
Get Metadata on File |
Retrieves a metadata instance for a file. |
Create Metadata on File |
Creates a metadata instance for a file. |
Update Metadata on File |
Updates a piece of metadata on a file. The metadata instance can be updated only if the instance already exists. When editing metadata, only values that adhere to the metadata template schema will be accepted. The update is applied atomically. If any errors occur during the application of the operations, then the metadata instance will not be changed. |
Delete Metadata on File |
Deletes the metadata instance for a file. |
Get Metadata on Folder |
Retrieves a metadata instance for a folder. |
Create Metadata on Folder |
Creates a metadata instance for a folder. |
Update Metadata on Folder |
Updates a piece of metadata on a folder. The metadata instance can be updated only if the instance already exists. When editing metadata, only values that adhere to the metadata template schema will be accepted. The update is applied atomically. If any errors occur during the application of the operations, then the metadata instance will not be changed. |
Delete Metadata on Folder |
Deletes the metadata instance for a folder. |
You must also select the metadata template to use for the operation. The Select Template field lists the templates that have been created.
To create a template, sign in to the Box Developer console. Select Admin Console, select Content to open the Content Manager, select the Metadata tab, and then click Create New.
For details about each operation and metadata templates, see the Box documentation.