Skip to main content
Version: Latest (4.54.0)

Box.com API

The Box.com component, allows you to talk with the Box.com.

It supports the following operations:

Folders

  • Get folder information
  • List items in a folder

Files

  • Get file information

Versions

  • Get version information (up to a maximum of 1000 versions)
  • For each previous version output the version information along with the original file

Downloads

  • Download file

Metadata

  • Getting file and folder custom metadata

Collaborations

  • Get collaboration information for a file or folder

The component uses the Box.com JWT auth mechanism. Please refer to the Box.com documentation for setting this up. Make sure to enable Perform Actions as Users. The ID of a user with sufficient privileges is needed and used for executing the API calls.

In addition, if you already know folders or files that belong to a certain user, you can access them using the Global Content Manager (GCM) scope. In this case, you can omit the Impersonation UserId.

Configuration

Inputs | Outputs


Box.com
Input
Output
Finished Output
Error
00 0 (ilyx1l)
Can be any message for triggering scraping Box.com based on the configuration or a message triggering a specific action. To trigger a specific action the following fields are required.

Example:
  • Mandatory fields:

    • id the id of the object to fetch
    • action the action to execute. Can be getFile, downloadFile, getFolder, getFolderItems or getCollaborations
When the action is downloadFile the following fields are required:
{
"id": "123456789",
// only applies when downloading a specific version:
"versionInfo": {
"id": "123456777",
}

}
For all the other actions an object with an id referring to a file or folder is required.

  • Optional fields:

    • recursive Overrides the recursion setting. If not set the recursion setting is used. Can be true or false.
    • impersonationUserID Overrides the Impersonation UserId setting. If not set the Impersonation UserId setting is used.

  • Example:
    {
    "id":"162661600318",
    "action":"getFile"
    }