Box Connector.

Additional Info

Requires Mule Enterprise License

Yes  

Requires Entitlement

No  

Mule Version

3.6.0 or higher

Configs


OAuth 2.0 Developer Token

<box:config-oauth-dev-token>

Connection Management

Connection to Box using developer token. A developer token can only be used to access a user's own apps hence this Config should not be used for production. A developer token is simply a short-lived access token that cannot be refreshed and can only be used with your own account. Therefore, they're only useful for testing an app and aren't suitable for production. One can obtain a developer token from your application's developer console.

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

developerToken

String

A token that behaves just like a full OAuth2 bearer token. It gives you access to your account on a temporary basis. Limitations:

  • It expires after 1 hour.
  • It is only valid for your own account (so you can't use them to test other people using your app).
  • There is no refresh token paired with the token.

x 


OAuth 2.0 Server to Server

<box:config-oauth-server-to-server>

Connection Management

Config for app-auth. This authentication method is meant for server-to-server applications and replaces the first leg of the standard 3-legged OAuth 2.0. Because your application authenticates directly to Box, this process removes the friction of multiple logins and services for your users. App Auth allows your application to request OAuth 2.0 access tokens necessary to make calls to the Box Content API. Your application may request one of two token types: Enterprise access token: Used to provision users via the /users endpoint. User access token: Used to make API calls to endpoints of the Content API.

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

clientId

String

The client ID of your application.

x 

clientSecret

String

The client password of your application.

x 

publicKeyId

String

ID of the Public Key configured in your Box instance to authenticate the application.

x 

privateKeyPath

String

Path to the PEM file containing the private key (private_key.pem).

x 

connectionType

ConnectionType

The type of the Entity ID. Accepted values are:

  • AS_USER
  • AS_ENTERPRISE_MANAGER

x 

encryptionAlgorithm

EncryptionAlgorithm

The RSA encryption algorithm used to encrypt the private key. Accepted values are:

  • RSA_SHA_384
  • RSA_SHA_512
  • RSA_SHA_256

x 

entityId

String

Enterprise ID or User ID.

x 

privateKeyPassword

String

The key (passphrase) used to encrypt the file containing the private key.

 


OAuth 2.0

<box:config-with-oauth>

OAuth2 Using OAuth2 as authentication method will add the authorize and unauthorize operations. You must authorize before using any operation with OAuth2.

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

clientId

String

The client ID of your application.

x 

clientSecret

String

The client secret of your application.

x 

baseUrl

String

The URL to which the API requests are directed.

https://api.box.com/2.0/

 

uploadUrl

String

The URL of the endpoints dedicated to file uploading operations.

https://upload.box.com/api/2.0/files

 

useGzip

boolean

If set to true, Box will be asked to gzip all its responses.

false

 

Processors


Folders | Get Folder’s Info

<box:get-folder-info>

Retrieves the full metadata about a folder, including information about when it was last updated as well as the files and folders contained in it. The root folder of a Box account is always represented by the id “0”.

XML Sample

<box:get-folder-info config-ref:"Box Config" folderId="#[flowVars.folderId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

folderId

String

The ID of the folder to be retrieved.

#[payload]

 

Returns

Return Java Type Description

Folder

A full folder object is returned, including the most current information available about it. An error is thrown if the folder does not exist or if the user does not

APIDoc Reference

https://box-content.readme.io/reference#folder-object


Folders | Get Folder’s Items

<box:get-folder-items>

Retrieves the files and/or folders contained within this folder without any other metadata about the folder. Any attribute in the full files or folders objects can be passed in with the fields parameter to get specific attributes, and only those specific attributes back; otherwise, the mini format is returned for each item by default. Multiple attributes can be passed in separated by commas e.g. fields=name,created_at.

XML Sample

<box:get-folder-items config-ref:"Box Config">
        <box:fields ref="#[flowVars.FieldsRef]"/>
    </box:get-folder-items>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

folderId

String

The ID of the folder you want to inspect. If not provided, the root folder is assumed.

0

 

fields

List<String>

Attribute(s) to include in the response.

 

Returns

Return Java Type Description

List<Item>

A collection of items contained in the folder is returned. An error is thrown if the folder does not exist, or if any of the parameters are invalid.

APIDoc Reference

https://box-content.readme.io/reference#get-a-folders-items


Folders | Create Folder

<box:create-folder>

Used to create a new empty folder. The new folder will be created inside of the specified parent folder.

XML Sample

<box:create-folder config-ref:"Box Config"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

folderName

String

The desired name for the folder.

#[payload]

 

parentId

String

The ID of the parent folder. Default value is "0", which represents the root folder.

0

 

Returns

Return Java Type Description

Folder

The the new folder.

APIDoc Reference

https://box-content.readme.io/reference#create-a-new-folder


Folders | Update Folder

<box:update-folder>

Used to update information about the folder. To move a folder, update the ID of its parent. To enable an email address that can be used to upload files to this folder, update the folder_upload_email attribute. An optional If-Match header can be included to ensure that client only updates the folder if it knows about the latest version.

XML Sample

<box:update-folder config-ref:"Box Config" folderId="#[flowVars.folderId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

folderId

String

The id of the folder to be modified.

x 

input

FolderInput

An instance of FolderInput with the attributes you want to change.

#[payload]

 

Returns

Return Java Type Description

Folder

The updated folder.

APIDoc Reference

https://box-content.readme.io/reference#update-information-about-a-folder


Folders | Delete Folder

<box:delete-folder>

Used to delete a folder. A recursive parameter must be included in order to delete folders that have items inside of them.

XML Sample

<box:delete-folder config-ref:"Box Config"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

folderId

String

The ID of the folder to be deleted.

#[payload]

 

recursive

boolean

Whether to delete this folder if it has items inside of it.

true

 

APIDoc Reference

https://box-content.readme.io/reference#delete-a-folder


Folders | Copy Folder

<box:copy-folder>

Used to create a copy of a folder in another folder. The original version of the folder will not be altered.

XML Sample

<box:copy-folder config-ref:"Box Config"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

folderId

String

The ID of the destination folder.

#[payload]

 

parentFolderId

String

The ID of the parent folder that will hold the copy. If not provided then the root will be used.

0

 

newName

String

An optional new name for the folder.

 

Returns

Return Java Type Description

Folder

The new copied folder. Errors can be thrown if the destination folder is invalid or if a file-name collision occurs. A 409 will be returned if the intended

APIDoc Reference

https://box-content.readme.io/reference#copy-a-folder


<box:create-shared-link-folder>

Used to create a shared link for the particular folder.

XML Sample

<box:create-shared-link-folder config-ref:"Box Config" folderId="#[flowVars.folderId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

folderId

String

The ID of the folder to whom a shared link to be created.

#[payload]

 

access

SharedLinkAccess

The level of access required for this shared link. Can be open, company, collaborators, or null to get default share level.

DEFAULT

 

unsharedAt

Date

The day that this link should be disabled at. RFC-3339 valid date-timestamps are rounded off to the given day. This field can only be set if the user has been granted permission (yes, it’s complicated) and is not a free user.

 

permissions

SharedLinkPermissions

The set of permissions that apply to this link.

x 

Returns

Return Java Type Description

SharedLink

A full folder object containing the updated shared link is returned if the ID is valid and if the update is successful.

APIDoc Reference

https://box-content.readme.io/reference#create-a-shared-link-for-a-folder


Folders | Get Folder Collaborations

<box:get-folder-collaborations>

Use this to get a list of all the collaborations on a folder i.e. all of the users that have access to that folder.

XML Sample

<box:get-folder-collaborations config-ref:"Box Config" folderId="#[flowVars.folderId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

folderId

String

The ID of the folder.

#[payload]

 

Returns

Return Java Type Description

List<Collaboration>

A collection of collaboration objects are returned. If there are no collaborations on this folder, an empty collection will be returned.

APIDoc Reference

https://box-content.readme.io/reference#view-a-folders-collaborations


Folders | Get Trashed Items

<box:get-trashed-items>

Retrieves the files and/or folders that have been moved to the trash. Any attribute in the full files or folders objects can be passed in with the fields parameter to get specific attributes, and only those specific attributes back; otherwise, the mini format is returned for each item by default. Multiple attributes can be passed in separated by commas e.g. fields=name,created_at. Paginated results can be retrieved using the limit and offset parameters.

XML Sample

<box:get-trashed-items config-ref:"Box Config">
        <box:fields ref="#[flowVars.FieldsRef]"/>
    </box:get-trashed-items>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fields

List<String>

Attribute(s) to include in the response

#[payload]

 

Returns

Return Java Type Description

List<Item>

The List of Items.

APIDoc Reference

https://box-content.readme.io/reference#get-the-items-in-the-trash


Folders | Get Trashed Folder

<box:get-trashed-folder>

Retrieves a folder that has been moved to the trash.

XML Sample

<box:get-trashed-folder config-ref:"Box Config">
        <box:fields ref="#[flowVars.FieldsRef]"/>
    </box:get-trashed-folder>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

folderId

String

The ID of the folder.

#[payload]

 

fields

List<String>

Attribute(s) to include in the response.

 

Returns

Return Java Type Description

Folder

The full item will be returned, including information about when the it was moved to the trash. A 404 will be returned if the item is not in the trash.

APIDoc Reference

https://box-content.readme.io/reference#get-a-trashed-folder


Folders | Permanently Delete

<box:permanently-delete-folder>

Permanently deletes an item that is in the trash. The item will no longer exist in Box. This action cannot be undone.

XML Sample

<box:permanently-delete-folder config-ref:"Box Config" folderId="#[flowVars.folderId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

folderId

String

The ID of the folder to be permanently deleted.

#[payload]

 

APIDoc Reference

https://box-content.readme.io/reference#permanently-delete-a-trashed-folder


Folders | Restore Folder

<box:restore-folder>

Restores an item that has been moved to the trash. Default behavior is to restore the item to the folder it was in before it was moved to the trash. If that parent folder no longer exists or if there is now an item with the same name in that parent folder, the new parent folder and/or new name will need to be included in the request.

XML Sample

<box:restore-folder config-ref:"Box Config"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

folderId

String

The ID of the trashed folder being restored.

#[payload]

 

newName

String

The new name for this item.

 

newParentId

String

The new parent folder for this item.

 

Returns

Return Java Type Description

Folder

The restored folder. By default it is restored to the parent folder it was in before it was trashed.

APIDoc Reference

https://box-content.readme.io/reference#restore-a-trashed-folder


Files | Get File’s Info

<box:get-file-info>

Retrieves the metadata about a file.

XML Sample

<box:get-file-info config-ref:"Box Config">
        <box:fields ref="#[flowVars.FieldsRef]"/>
    </box:get-file-info>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file.

#[payload]

 

fields

List<String>

Attribute(s) to include in the response.

 

Returns

Return Java Type Description

File

A full file object is returned if the ID is valid and if the user has access to the file.

APIDoc Reference

https://box-content.readme.io/reference#files


Files | Update File Info

<box:update-file-info>

Used to update individual or multiple fields in the file object, including renaming the file, changing its description, and creating a shared link for the file. To move a file, change the ID of its parent folder.

XML Sample

<box:update-file-info config-ref:"Box Config" info-ref="#[flowVars.info]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file.

#[payload]

 

fileInfo

FileInput

The updated file info object.

x 

Returns

Return Java Type Description

File

The updated file.

APIDoc Reference

https://box-content.readme.io/reference#update-a-files-information


Files | Download File

<box:download-file>

Retrieves the actual data of the file.

XML Sample

<box:download-file config-ref:"Box Config" fileId="#[flowVars.fileId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file.

#[payload]

 

Returns

Return Java Type Description

InputStream

An InputStream with the downloaded file.

APIDoc Reference

https://box-content.readme.io/reference#download-a-file


Files | Get download URL

<box:get-download-u-r-l>

Retrieves the download URL of the file.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file.

#[payload]

 

Returns

Return Java Type Description

String

The URL to download the file.


Files | Upload File

<box:upload-file>

Uploads a new file to the specified folder.

XML Sample

<box:upload-file config-ref:"Box Config" fileName="#[flowVars.fileName]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileName

String

The name to give the uploaded file.

x 

folderId

String

The ID of the folder.

0

 

fileContent

InputStream

A stream containing the contents of the file to upload.

#[payload]

 

Returns

Return Java Type Description

File

The uploaded file.

APIDoc Reference

https://box-content.readme.io/reference#upload-a-file


Files | Delete File

<box:delete-file>

Discards a file to the trash.

XML Sample

<box:delete-file config-ref:"Box Config" fileId="#[flowVars.fileId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file.

[#payload]

 

APIDoc Reference

https://box-content.readme.io/reference#delete-a-file


Files | Update File

<box:upload-new-version>

Uploading a new file version is performed in the same way as uploading a file. This method uploads a new version of an existing file in a user’s account.

XML Sample

<box:upload-new-version config-ref:"Box Config" fileId="#[flowVars.fileId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file.

x 

fileContent

InputStream

A stream containing the new file contents.

[#payload]

 

modifiedAt

Date

The date that the new version was modified.

 

Returns

Return Java Type Description

File

The updated file.

APIDoc Reference

https://box-content.readme.io/reference#upload-a-new-version-of-a-file


Files | View Versions

<box:get-file-versions>

Retrieved any previous versions of the specified file. Note that versions are only tracked for users with premium accounts.

XML Sample

<box:get-file-versions config-ref:"Box Config" fileId="#[flowVars.fileId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file.

x 

Returns

Return Java Type Description

List<FileVersion>

An array of version objects are returned. If there are no previous versions of this file, then an empty array will be returned.

APIDoc Reference

https://box-content.readme.io/reference#view-versions-of-a-file


Files | Download Version

<box:download-file-version>

Downloads previous versions of a file. Only for users with premium accounts.

XML Sample

<box:download-file-version config-ref:"Box Config" versionId="#[flowVars.versionId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file.

#[payload]

 

versionId

String

The version ID of specified version of the file.

x 

Returns

Return Java Type Description

InputStream

An InputStream containing the file contents.

APIDoc Reference

https://box-content.readme.io/reference#download-an-old-version-of-a-file


Files | Promote Version

<box:promote-file-version>

For users with premium accounts, If there are previous versions of this file, this method can be used to promote one of the older versions to the top of the stack. This actually mints a copy of the old version and puts it on the top of the versions stack.

XML Sample

<box:promote-file-version config-ref:"Box Config" versionId="#[flowVars.versionId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file.

#[payload]

 

versionId

String

The version ID of specified version of the file.

x 

APIDoc Reference

https://box-content.readme.io/reference#promote-an-old-version-of-a-file


Files | Delete Old Version

<box:delete-old-file-version>

Discards a specific file version to the trash.

XML Sample

<box:delete-old-file-version config-ref:"Box Config" versionId="#[flowVars.versionId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file.

#[payload]

 

versionId

String

The version ID of specified version of the file.

x 

APIDoc Reference

https://box-content.readme.io/reference#delete-an-old-version-of-a-file


Files | Copy And Rename File

<box:copy-file>

Creates a copy of a file in another folder and rename it. The original version of the file will not be altered.

XML Sample

<box:copy-file config-ref:"Box Config"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file you want to copy.

#[payload]

 

folderId

String

The folder ID representing the new location of the file.

0

 

newName

String

An optional new name for the file.

x 

Returns

Return Java Type Description

File

The new file. Errors can be thrown if the destination folder is invalid or if a file-name collision occurs.

APIDoc Reference

https://box-content.readme.io/reference#copy-a-file


Files | Get Thumbnail

<box:get-thumbnail>

Retrieves a thumbnail, or smaller image representation, of this file. Sizes of 32x32, 64x64, 128x128, and 256x256 can be returned in the .png format and sizes of 32x32, 94x94, 160x160, and 320x320 can be returned in the .jpg format.

XML Sample

<box:get-thumbnail config-ref:"Box Config" minWidth="#[flowVars.minWidth]"  minHeight="#[flowVars.minHeight]"  maxWidth="#[flowVars.maxWidth]"  maxHeight="#[flowVars.maxHeight]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file

#[payload]

 

thumbnailType

ThumbnailType

Either PNG of JPG

PNG

 

minWidth

Integer

The minimum width of the thumbnail

x 

minHeight

Integer

The minimum height of the thumbnail

x 

maxWidth

Integer

The maximum width of the thumbnail

x 

maxHeight

Integer

The maximum height of the thumbnail

x 

Returns

Return Java Type Description

InputStream

The byte array of the thumbnail image

APIDoc Reference

https://box-content.readme.io/reference#get-a-thumbnail-for-a-file


<box:get-file-preview-link>

Retrieves an expiring URL for creating an embedded preview session. The URL will expire after 60 seconds and the preview session will expire after 60 minutes.

XML Sample

<box:get-file-preview-link config-ref:"Box Config" fileId="#[flowVars.fileId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file.

#[payload]

 

Returns

Return Java Type Description

URL

The expiring preview link.

APIDoc Reference

https://box-content.readme.io/reference#get-embed-link


<box:create-shared-link-file>

Createe a shared link for this particular file.

XML Sample

<box:create-shared-link-file config-ref:"Box Config" fileId="#[flowVars.fileId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file

#[payload]

 

access

SharedLinkAccess

The level of access required for this shared link. Can be open, company, collaborators, or null to get default share level.

DEFAULT

 

unsharedAt

Date

The day that this link should be disabled at. Timestamps are rounded off to the given day. This field can only be set if the user is not a free user.

 

permissions

SharedLinkPermissions

The set of permissions that apply to this link

x 

Returns

Return Java Type Description

SharedLink

A full file object containing the updated shared link is returned if the ID is valid and if the update is successful.

APIDoc Reference

https://box-content.readme.io/reference#create-a-shared-link-for-a-file


Files | Get Trashed File

<box:get-trashed-file>

Retrieves an item that has been moved to the trash.

XML Sample

<box:get-trashed-file config-ref:"Box Config">
        <box:fields ref="#[flowVars.FieldsRef]"/>
    </box:get-trashed-file>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file.

#[payload]

 

fields

List<String>

Attribute(s) to include in the response.

 

Returns

Return Java Type Description

File

The full item will be returned, including information about when the it was moved to the trash.

APIDoc Reference

https://box-content.readme.io/reference#get-a-trashed-file


Files | Permanently Delete

<box:permanently-delete-file>

Permanently deletes an item that is in the trash. The item will no longer exist in Box. This action cannot be undone.

XML Sample

<box:permanently-delete-file config-ref:"Box Config" fileId="#[flowVars.fileId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file to be permanently deleted.

#[payload]

 

APIDoc Reference

https://box-content.readme.io/reference#permanently-delete-a-trashed-file


Files | Restore Item

<box:restore-file>

Restores an item that has been moved to the trash. Default behavior is to restore the item to the folder it was in before it was moved to the trash. If that parent folder no longer exists or if there is now an item with the same name in that parent folder, the new parent folder and/or new name will need to be included in the request.

XML Sample

<box:restore-file config-ref:"Box Config"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the trashed file being restored.

#[payload]

 

newName

String

The new name for this item.

 

newParentId

String

The new parent folder for this item.

 

Returns

Return Java Type Description

File

The returned file. By default it is restored to the parent folder it was in before it was trashed.

APIDoc Reference

https://box-content.readme.io/reference#restore-a-trashed-item


Files | View Comments

<box:get-file-comments>

Gets a list of any comments on this file.

XML Sample

<box:get-file-comments config-ref:"Box Config" fileId="#[flowVars.fileId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file.

#[payload]

 

Returns

Return Java Type Description

List<Comment>

A collection of comment objects are returned. If there are no comments on the file, an empty comments array is returned.

APIDoc Reference

https://box-content.readme.io/reference#view-the-comments-on-a-file


Files | Get File’s Tasks

<box:get-file-tasks>

Retrieves all of the tasks for given file.

XML Sample

<box:get-file-tasks config-ref:"Box Config" fileId="#[flowVars.fileId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file.

#[payload]

 

Returns

Return Java Type Description

List<Task>

A collection of mini task objects is returned. If there are no tasks, an empty collection will be returned.

APIDoc Reference

https://box-content.readme.io/reference#get-the-tasks-for-a-file


Comments | Get Comment

<box:get-comment-info>

Used to retrieve the message and metadata about a specific comment. Information about the user who created the comment is also included.

XML Sample

<box:get-comment-info config-ref:"Box Config" commentId="#[flowVars.commentId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

commentId

String

The ID of the comment.

#[payload]

 

Returns

Return Java Type Description

Comment

A full comment object is returned is the ID is valid and if the user has access to the comment.

APIDoc Reference

https://box-content.readme.io/reference#comments


Comments | Create Comment

<box:add-comment-to-file>

Used to add a comment by the user to a specific file.

XML Sample

<box:add-comment-to-file config-ref:"Box Config" message="#[flowVars.message]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the file.

#[payload]

 

message

String

The text body of the comment.

x 

Returns

Return Java Type Description

Comment

The comment. Errors may occur if the item id is invalid, the item type is invalid/unsupported, you don’t include either a message or a tagged_message, or if the user

APIDoc Reference

https://box-content.readme.io/reference#add-a-comment-to-an-item


Comments | Reply to Comment

<box:reply-to-comment>

Replies to this comment with another message.

XML Sample

<box:reply-to-comment config-ref:"Box Config" message="#[flowVars.message]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

commentId

String

The ID of the comment.

#[payload]

 

message

String

The text body of the comment

x 

Returns

Return Java Type Description

Comment

The created reply comment.


Comments | Update Comment

<box:update-comment>

Used to update the message of the comment.

XML Sample

<box:update-comment config-ref:"Box Config" message="#[flowVars.message]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

commentId

String

The ID of the comment.

#[payload]

 

message

String

The desired text for the comment message.

x 

Returns

Return Java Type Description

Comment

The updated comment.

APIDoc Reference

https://box-content.readme.io/reference#change-a-comments-message


Comments | Delete Comment

<box:delete-comment>

Permanently deletes a comment.

XML Sample

<box:delete-comment config-ref:"Box Config" commentId="#[flowVars.commentId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

commentId

String

The ID of the comment.

#[payload]

 

APIDoc Reference

https://box-content.readme.io/reference#delete-a-comment


Tasks | Create Task

<box:add-task-to-file>

Used to create a single task for single user on a single file.

XML Sample

<box:add-task-to-file config-ref:"Box Config"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileId

String

The ID of the item this task is for.

#[payload]

 

message

String

An optional message to include with the task.

 

dueAt

Date

The day at which this task is due.

 

Returns

Return Java Type Description

Task

The new task object will be returned upon success.

APIDoc Reference

https://box-content.readme.io/reference#create-a-task


Tasks | Get Task

<box:get-task-info>

Fetches a specific task.

XML Sample

<box:get-task-info config-ref:"Box Config" taskId="#[flowVars.taskId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

taskId

String

The ID of the task.

#[payload]

 

Returns

Return Java Type Description

Task

The specified task object will be returned upon success.

APIDoc Reference

https://box-content.readme.io/reference#task-object


Tasks | Update Task

<box:update-task-info>

Updates a specific task.

XML Sample

<box:update-task-info config-ref:"Box Config" info-ref="#[flowVars.info]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

taskId

String

The ID of the task.

#[payload]

 

taskInfo

TaskInput

The updated info.

x 

Returns

Return Java Type Description

Task

The updated task.

APIDoc Reference

https://box-content.readme.io/reference#update-a-task


Tasks | Delete Task

<box:delete-task>

Permanently deletes a specific task.

XML Sample

<box:delete-task config-ref:"Box Config" taskId="#[flowVars.taskId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

taskId

String

The ID of the task.

#[payload]

 

APIDoc Reference

https://box-content.readme.io/reference#delete-a-task


Tasks | Get Assignments

<box:get-task-assignments>

Retrieves all of the assignments for a given task.

XML Sample

<box:get-task-assignments config-ref:"Box Config" taskId="#[flowVars.taskId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

taskId

String

The ID of the task.

#[payload]

 

Returns

Return Java Type Description

List<Assignment>

A collection of task assignment mini objects will be returned upon success.

APIDoc Reference

https://box-content.readme.io/reference#get-the-assignments-for-a-task


Tasks | Get Task Assignment

<box:get-task-assignment-info>

Fetches a specific task assignment.

XML Sample

<box:get-task-assignment-info config-ref:"Box Config" assignmentId="#[flowVars.assignmentId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

assignmentId

String

The ID of the task assignment.

#[payload]

 

Returns

Return Java Type Description

Assignment

The specified task assignment object will be returned upon success.

APIDoc Reference

https://box-content.readme.io/reference#get-a-task-assignment


Tasks | Create Task Assignment

<box:add-task-assignment>

Used to assign a task to a single user. There can be multiple assignments on a given task.

XML Sample

<box:add-task-assignment config-ref:"Box Config" assignTo="#[flowVars.assignTo]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

taskId

String

The ID of the task this assignment is for.

#[payload]

 

assignTo

String

The ID of the user this assignment is for.

x 

Returns

Return Java Type Description

Assignment

The new task assignment object will be returned upon success.

APIDoc Reference

https://box-content.readme.io/reference#create-a-task-assignment


Tasks | Update Task Assignment

<box:update-task-assignment-info>

Updates a task assignment.

XML Sample

<box:update-task-assignment-info config-ref:"Box Config" info-ref="#[flowVars.info]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

assignmentId

String

The ID of the task assignment.

#[payload]

 

taskAssignmentInfo

AssignmentInput

The task assignment updated info.

x 

Returns

Return Java Type Description

Assignment

The updated Assignment.

APIDoc Reference

https://box-content.readme.io/reference#update-a-task-assignment


Tasks | Delete Task Assignment

<box:delete-task-assignment>

Deletes a specific task assignment.

XML Sample

<box:delete-task-assignment config-ref:"Box Config" assignmentId="#[flowVars.assignmentId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

assignmentId

String

The ID of the task assignment.

#[payload]

 

APIDoc Reference

https://box-content.readme.io/reference#delete-a-task-assignment


Users | Create User

<box:create-app-user>

Used to provision a new user in an enterprise. This method only works for enterprise admins.

XML Sample

<box:create-app-user config-ref:"Box Config" emailAddress="#[flowVars.emailAddress]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

username

String

The name of this user.

#[payload]

 

Returns

Return Java Type Description

User

Returns the full user object for the newly created user. Errors may be thrown when the fields are invalid or this API call is made from a non-admin account.

APIDoc Reference

https://box-content.readme.io/reference#create-an-enterprise-user


Users | Get Current User

<box:get-current-user>

Retrieves information about the user who is currently logged in i.e. the user for whom this auth token was generated.

XML Sample

<box:get-current-user config-ref:"Box Config">
        <box:fields ref="#[flowVars.FieldsRef]"/>
    </box:get-current-user>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fields

List<String>

Attribute(s) to include in the response

 

Returns

Return Java Type Description

User

Returns a single complete user object.

APIDoc Reference

https://box-content.readme.io/reference#get-the-current-users-information


Users | Get User’s Info

<box:get-user-info>

Retrieves information about a user in the enterprise. Requires enterprise administration authorization.

XML Sample

<box:get-user-info config-ref:"Box Config">
        <box:fields ref="#[flowVars.FieldsRef]"/>
    </box:get-user-info>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The ID of the user.

#[payload]

 

fields

List<String>

Attribute(s) to include in the response.

 

Returns

Return Java Type Description

User

Returns a single complete user object.

APIDoc Reference

https://box-content.readme.io/reference#users


Users | Get Enterprise Users

<box:get-enterprise-users>

Returns a list of all users for the Enterprise along with their user_id, public_name, and login.

XML Sample

<box:get-enterprise-users config-ref:"Box Config"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

List<User>

Returns the list of all users for the Enterprise with their user_id, public_name, and login if the user is an enterprise admin.

APIDoc Reference

https://box-content.readme.io/reference#get-all-users-in-an-enterprise


Users | Update User

<box:update-user-info>

Used to edit the settings and information about a user. This method only works for enterprise admins.

XML Sample

<box:update-user-info config-ref:"Box Config" info-ref="#[flowVars.info]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The ID of the user.

x 

input

UserInput

User updated info.

#[payload]

 

Returns

Return Java Type Description

User

The updated user.

APIDoc Reference

https://box-content.readme.io/reference#update-a-users-information


Users | Delete User

<box:delete-user>

Deletes a user in an enterprise account.

XML Sample

<box:delete-user config-ref:"Box Config"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The ID of the user.

#[payload]

 

notifyUser

boolean

Determines if the destination user should receive email notification of the transfer.

true

 

force

boolean

Whether or not the user should be deleted even if this user still own files.

false

 

APIDoc Reference

https://box-content.readme.io/reference#delete-an-enterprise-user


Users | Move User’s Folder

<box:move-folder-to-user>

Moves all of the owned content from within one user’s folder into a new folder in another user’s account. You can move folders across users as long as the you have administrative permissions and the ‘source’ user owns the folders.

XML Sample

<box:move-folder-to-user config-ref:"Box Config" targetUserId="#[flowVars.targetUserId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The ID of the user.

#[payload]

 

targetUserId

String

the user id of the user whose files will be the source for this operation

x 

Returns

Return Java Type Description

Folder

The information for the newly created destination folder. An error is thrown if you do not have the necessary permissions to move the folder.

APIDoc Reference

https://box-content.readme.io/reference#move-folder-into-another-users-folder


Groups | Create Group

<box:create-group>

Used to create a group.

XML Sample

<box:create-group config-ref:"Box Config"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

groupName

String

The name of the new group to be created

#[payload]

 

Returns

Return Java Type Description

Group

The new group object will be returned upon success.

APIDoc Reference

https://box-content.readme.io/reference#create-a-group


Groups | Get Group

<box:get-group-info>

Retrieves information about a group.

XML Sample

<box:get-group-info config-ref:"Box Config" groupId="#[flowVars.groupId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

groupId

String

The ID of the group.

#[payload]

 

Returns

Return Java Type Description

Group

A group object that was requested.

APIDoc Reference

https://box-content.readme.io/reference#get-group


Groups | Delete Group

<box:delete-group>

Permanently deletes a specific group.

XML Sample

<box:delete-group config-ref:"Box Config" groupId="#[flowVars.groupId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

groupId

String

The ID of the group.

#[payload]

 

APIDoc Reference

https://box-content.readme.io/reference#delete-a-group


Groups | Create Membership

<box:add-group-membership>

Adds a member to a Group.

XML Sample

<box:add-group-membership config-ref:"Box Config" boxUser-ref="#[flowVars.boxUser]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

groupId

String

The group this user is to be added to.

#[payload]

 

userId

String

The UserId of the BoxUser to assign to a group

x 

membershipRole

MembershipRole

The membershipRole of the user in the group. Default is “member” option for “admin”

MEMBER

 

Returns

Return Java Type Description

Membership

The new group membership object will be returned upon success.

APIDoc Reference

https://box-content.readme.io/reference#add-a-member-to-a-group


Groups | Get Memberships for Group

<box:get-group-memberships>

Retrieves all of the members for a given group if the requesting user has access

XML Sample

<box:get-group-memberships config-ref:"Box Config" groupId="#[flowVars.groupId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

groupId

String

The ID of the group.

#[payload]

 

Returns

Return Java Type Description

List<Membership>

A collection of group membership objects will be returned upon success.

APIDoc Reference

https://box-content.readme.io/reference#get-the-membership-list-for-a-group


Groups | Get Membership

<box:get-group-membership>

Fetches a specific group membership entry.

XML Sample

<box:get-group-membership config-ref:"Box Config" groupMemberShipId="#[flowVars.groupMemberShipId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

groupMemberShipId

String

The ID of the group membership.

#[payload]

 

Returns

Return Java Type Description

Membership

The specified group_membership object will be returned upon success.

APIDoc Reference

https://box-content.readme.io/reference#get-a-group-membership-entry


Groups | Update Membership for a Group

<box:update-group-membership>

Updates a group membership.

XML Sample

<box:update-group-membership config-ref:"Box Config" info-ref="#[flowVars.info]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

groupMemberShipId

String

The ID of the group membership.

x 

groupMembership

MembershipInput

The updated group membership.

#[payload]

 

Returns

Return Java Type Description

Membership

The updated group membership.

APIDoc Reference

https://box-content.readme.io/reference#update-a-group-membership


Groups | Delete Membership

<box:delete-group-membership>

Deletes a specific group membership.

XML Sample

<box:delete-group-membership config-ref:"Box Config" groupMemberShipId="#[flowVars.groupMemberShipId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

groupMemberShipId

String

The ID of the group membership.

#[payload]

 

APIDoc Reference

https://box-content.readme.io/reference#delete-a-group-membership


Groups | Get Groups for an Enterprise

<box:get-all-groups>

Retrieves all of the groups that the current user is a member of.

XML Sample

<box:get-all-groups config-ref:"Box Config"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

List<Group>

A collection of group objects.

APIDoc Reference

https://box-content.readme.io/reference#groups


Groups | Get User’s Memberships

<box:get-user-group-memberships>

Retrieves all of the group memberships for a given user. Note this is only available to group admins.

XML Sample

<box:get-user-group-memberships config-ref:"Box Config" userId="#[flowVars.userId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The ID of the user.

#[payload]

 

Returns

Return Java Type Description

List<Membership>

A collection of group membership objects will be returned upon success.


Collaborations | Create Collaboration

<box:create-collaboration>

Adds a collaboration for a single user or a single group to a folder. Either an email address, a user ID, or a group id can be used to create the collaboration.

XML Sample

<box:create-collaboration config-ref:"Box Config" collaborator-ref="#[flowVars.collaborator]"  role="#[flowVars.role]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

folderId

String

The ID of the item to add the collaboration on.

#[payload]

 

collaboratorId

String

The collaboratorId to add.

x 

collaborationRole

CollaborationRole

The collaborationRole of the collaboratorId.

x 

Returns

Return Java Type Description

Collaboration

The new collaboration object is returned.

APIDoc Reference

https://box-content.readme.io/reference#add-a-collaboration


Collaborations | Get Collaboration

<box:get-collaboration-info>

Retrieves information about a single collaboration.

XML Sample

<box:get-collaboration-info config-ref:"Box Config" collaborationId="#[flowVars.collaborationId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

collaborationId

String

The ID of the collaboration.

#[payload]

 

Returns

Return Java Type Description

Collaboration

The collaboration object is returned. Errors may occur if the IDs are invalid or if the user does not have permissions to see the collaboration.

APIDoc Reference

https://box-content.readme.io/reference#get-collabs


Collaborations | Update Collaboration

<box:update-collaboration>

Used to edit an existing collaboration. Descriptions of the various roles can be found here.

XML Sample

<box:update-collaboration config-ref:"Box Config" info-ref="#[flowVars.info]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

collaborationId

String

The ID of the collaboration.

#[payload]

 

input

CollaborationInput

Contains information about a BoxCollaboration.

x 

Returns

Return Java Type Description

Collaboration

The updated collaboration.

APIDoc Reference

https://box-content.readme.io/reference#edit-a-collaboration


Collaborations | Delete Collaboration

<box:delete-collaboration>

Used to delete a single collaboration.

XML Sample

<box:delete-collaboration config-ref:"Box Config" collaborationId="#[flowVars.collaborationId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

collaborationId

String

The ID of the collaboration.

#[payload]

 

APIDoc Reference

https://box-content.readme.io/reference#remove-a-collaboration


Collaborations | Pending Collaborations

<box:get-pending-collaborations>

Used to retrieve all pending collaboration invites for this user.

XML Sample

<box:get-pending-collaborations config-ref:"Box Config"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

List<Collaboration>

A collection of pending collaboration objects are returned. If the user has no pending collaborations, the collection will be empty.

APIDoc Reference

https://box-content.readme.io/reference#get-pending-collaborations


<box:search>

The search endpoint provides a simple way of finding items that are accessible in a given user’s Box account.

XML Sample

<box:search config-ref:"Box Config" query="#[flowVars.query]"  parentFolderId="#[flowVars.parentFolderId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

query

String

The string to search for; can be matched against item names, descriptions, text content of a file, and other fields of the different item types.

#[payload]

 

parentFolderId

String

The ID of the folder in which the search operation will be applied. If the ID is not specified it will be done in the root folder.

x 

Returns

Return Java Type Description

List<Item>

A collection of the found Item elements.