Contact Free trial Login

Box Connector Reference 4.0 - Mule 4

Support Category: Select

Anypoint Connector for Box (Box Connector) provides access to the Box Content API for secure content management and content experience features for use in your own app. The connector strives to be RESTful and is organized around the main resources you’re familiar with from the Box web interface.

Configurations

Parameters

Name Type Description Default Value Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x 

Connection

Connection types to provide to this configuration

x 

host

String

Host for consuming API

api.box.com

 

port

String

Port for consuming API

443

 

basePath

String

Basepath for consuming API

/2.0

 

protocol

String

Protocol for consuming API

HTTPS

 

Response timeout

String

Maximum time in milliseconds that the request element can block the execution of the flow while waiting for the HTTP response.

10000

 

clientId

String

OAuth2 Client Id

x 

clientSecret

String

OAuth2 Client Secret

x 

localCallbackPath

String

Path for autogenerating the local callback endpoint

/callback

 

localCallbackConfig

String

HTTP Listener Configuration name for exposing the callback endpoint

cloudhub_http

 

externalCallbackUrl

String

URL for redirecting after the OAuth dance login

http://my-app.cloudhub.io/callback

 

localAuthorizationUrl

String

Local URL for autogenerating the endpoint that starts the OAuth dance

http://localhost:8081/authorize

 

authorizationUrl

String

Authorization URL for consuming API

https://account.box.com/api/oauth2/authorize

 

accessTokenUrl

String

Token URL for consuming the API

https://api.box.com/oauth2/token

 

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

 

Connection Types

Connection

Operations

Copy File

<box-connector:copy-file>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Copy File Request Data

Any

#[payload]

 

File Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Copy Folder

<box-connector:copy-folder>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Copy Folder Request Data

Any

#[payload]

 

Fields

String

Attribute(s) to include in the response

 

Folder Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Create Collaboration

<box-connector:create-collaboration>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Create Collaboration Request Data

Any

#[payload]

 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Create Comment

<box-connector:create-comment>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Create Comment Request Data

Any

#[payload]

 

Fields

String

Attribute(s) to include in the response

 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Create Folder

<box-connector:create-folder>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Create Folder Request Data

Any

#[payload]

 

Fields

String

Attribute(s) to include in the response

 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Create Group

<box-connector:create-group>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Create Group Request Data

Any

#[payload]

 

Fields

String

Attribute(s) to include in the response

 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Create Group Membership

<box-connector:create-group-membership>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Create Group Membership Request Data

Any

#[payload]

 

Fields

String

Attribute(s) to include in the response

 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Create Task

<box-connector:create-task>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Create Task Request Data

Any

#[payload]

 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Create Task Assignment

<box-connector:create-task-assignment>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Create Task Assignment Request Data

Any

#[payload]

 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Create User

<box-connector:create-user>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Create User Request Data

Any

#[payload]

 

Fields

String

Attribute(s) to include in the response

 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Delete Collaboration

<box-connector:delete-collaboration>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Collab Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Delete Comment

<box-connector:delete-comment>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Comment Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Delete File

<box-connector:delete-file>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

File Id

String

x 

If Match

String

The etag of the file. This is in the ‘etag’ field of the file object.

 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Delete File Version

<box-connector:delete-file-version>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

File Id

String

x 

Version Id

String

x 

If Match

String

The etag of the file. This is in the ‘etag’ field of the file object.

 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Delete Folder

<box-connector:delete-folder>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Recursive

Boolean

 

Folder Id

String

x 

If Match

String

This is in the ‘etag’ field of the folder object.

 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Delete Group

<box-connector:delete-group>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Group Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Delete Group Membership

<box-connector:delete-group-membership>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Group Membership Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Delete Task

<box-connector:delete-task>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Task Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Delete Task Assignment

<box-connector:delete-task-assignment>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Task Assignment Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Delete Trashed File

<box-connector:delete-trashed-file>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

File Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Delete Trashed Folder

<box-connector:delete-trashed-folder>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Folder Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Delete User

<box-connector:delete-user>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Notify

Boolean

 

Force

Boolean

 

User Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get Collaboration

<box-connector:get-collaboration>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Fields

String

Attribute(s) to include in the response

 

Status

Enumeration, one of:

  • pending

Must be 'pending'

x 

Collab Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get Comment

<box-connector:get-comment>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Fields

String

Attribute(s) to include in the response.

 

Comment Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get Enterprise Groups

<box-connector:get-enterprise-groups>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Fields

String

Attribute(s) to include in the response

 

Limit

Number

The maximum number of items to return in a page. The default is 100 and the max is 1000.

 

Offset

Number

The item at which to begin the response.

 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get Enterprise Users

<box-connector:get-enterprise-users>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Fields

String

Attribute(s) to include in the response

 

Filter Term

String

A string used to filter the results to only users starting with the filter_term in either the name or the login.

 

Limit

Number

The number of records to return. The default is 100 and the max is 1000.

 

Offset

Number

The record at which to start. The default is 0.

 

User Type

Enumeration, one of:

  • all

  • external

  • managed

The type of user to search for. Valid values are all, external or managed. If nothing is provided, the default behavior will be managed only

 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get File

<box-connector:get-file>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Fields

String

Attribute(s) to include in the response.

 

File Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get File Comments

<box-connector:get-file-comments>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Fields

String

Attribute(s) to include in the response

 

File Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get File Content

<box-connector:get-file-content>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Version

String

The ID specific version of this file to download.

 

File Id

String

x 

Range

String

The range value in bytes. Format should be bytes={start_range}-{end_range}

 

Box Api

String

The shared link for this item. Format should be shared_link=SHARED_LINK

 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Binary

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get File Tasks

<box-connector:get-file-tasks>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Fields

String

Attribute(s) to include in the response

 

File Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get File Thumbnail

<box-connector:get-file-thumbnail>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Min Height

Number

The minimum height of the thumbnail

 

Min Width

Number

The minimum width of the thumbnail

 

Max Height

Number

The maximum height of the thumbnail

 

Max Width

Number

The maximum width of the thumbnail

 

File Id

String

x 

Extension

String

The preview format, e.g. png or jpg

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get File Versions

<box-connector:get-file-versions>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Fields

String

Attribute(s) to include in the response

 

File Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get Folder

<box-connector:get-folder>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Fields

String

Attribute(s) to include in the response

 

Folder Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get Folder Collaborations

<box-connector:get-folder-collaborations>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Fields

String

Attribute(s) to include in the response

 

Limit

Number

The maximum number of items to return in a page. The default is 100 and the max is 1000.

 

Offset

Number

The item at which to begin the response

 

Folder Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get Folder Items

<box-connector:get-folder-items>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Fields

String

Attribute(s) to include in the response

 

Limit

Number

The maximum number of items to return in a page. The default is 100 and the max is 1000.

 

Offset

String

The offset at which to begin the response. An offset of value of 0 will start at the beginning of the folder-listing. Note: If there are hidden items in your previous response, your next offset should be = offset + limit, not the # of records you received back. The default is 0.

 

Folder Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get Group

<box-connector:get-group>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Fields

String

Attribute(s) to include in the response

 

Group Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get Group Membership

<box-connector:get-group-membership>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Fields

String

Attribute(s) to include in the response

 

Group Membership Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get Group Memberships

<box-connector:get-group-memberships>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Fields

String

Attribute(s) to include in the response

 

Limit

Number

The maximum number of items to return in a page. The default is 100 and the max is 1000.

 

Offset

Number

The item at which to begin the response.

 

Group Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get Pending Collaborations

<box-connector:get-pending-collaborations>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Fields

String

Attribute(s) to include in the response

 

Status

Enumeration, one of:

  • pending

Must be 'pending'

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get Task

<box-connector:get-task>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Fields

String

Attribute(s) to include in the response

 

Task Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get Task Assignment

<box-connector:get-task-assignment>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Fields

String

Attribute(s) to include in the response

 

Task Assignment Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get Task Assignments

<box-connector:get-task-assignments>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Fields

String

Attribute(s) to include in the response

 

Task Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get Trashed File

<box-connector:get-trashed-file>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

File Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get Trashed Folder

<box-connector:get-trashed-folder>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Fields

String

Attribute(s) to include in the response

 

Folder Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get Trashed Items

<box-connector:get-trashed-items>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Fields

String

Attribute(s) to include in the response

 

Limit

Number

The maximum number of items to return

 

Offset

Number

The item at which to begin the response

 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get User

<box-connector:get-user>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Fields

String

Attribute(s) to include in the response

 

User Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Get User Group Membership

<box-connector:get-user-group-membership>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Fields

String

Attribute(s) to include in the response

 

Limit

Number

Default is 100. Max is 1000

 

Offset

Number

The item at which to begin the response

 

User Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Promote File Version

<box-connector:promote-file-version>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Promote File Version Request Data

Any

#[payload]

 

File Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Restore Trashed File

<box-connector:restore-trashed-file>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Restore Trashed File Request Data

Any

#[payload]

 

File Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Restore Trashed Folder

<box-connector:restore-trashed-folder>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Restore Trashed Folder Request Data

Any

#[payload]

 

Fields

String

Attribute(s) to include in the response

 

Folder Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

<box-connector:search>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Query

String

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

x 

Scope

String

The scope for which to limit the search. Can be user_content for a search limited to only the current user or enterprise_content for the entire enterprise. To enable the enterprise_content scope for an administrator, contact MuleSoft.

 

File Extensions

String

Limit searches to specific file extensions like pdf,png,doc. Requires one or a set of comma delimited file extensions: file_extension_1,file_extension_2,…​.

 

Created At Range

Date

The date for when the item was created. Specify the date range by using RFC3339 timestamp variables separated by a comma: from_date,to_date (e.g 2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00). Trailing from_date, and leading ,to_date commas are also accepted, where the current date and earliest known date will be designated respectively.

 

Updated At Range

Date

The date for when the item was last updated. Specify the date range by using RFC3339 variables separated by a comma: from_date,to_date(e.g 2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00). Trailing from_date, and leading ,to_date commas are also accepted, where the current date and earliest known date will be designated respectively.

 

Size Range

Number

Filter by a file size range. Specify the file size range in bytes separated by a comma: lower_bound_size,upper_bound_size, where 1MB is equivalent to 1000000 bytes. Trailing lower_bound_size, and leading,upper_bound_size commas are also accepted as parameters.

 

Owner User Ids

String

Search by item owners. Requires one, or a set of, comma-delimited user_ids: user_id_1,user_id_2,…​

 

Ancestor Folder Ids

String

Limit searches to specific parent folders. Requires one, or a set of, comma-delimited folder_ids: folder_id_1,folder_id_2,…​. Parent folder results also include items within subfolders.

 

Content Types

String

Limit searches to specific Box designated content types. Can be name, description, file_content, comments, or tags. Requires one, or a set of, comma-delimited content_types: content_type_1,content_type_2,…​.

 

Type

Enumeration, one of:

  • file

  • folder

  • web_link

The type you want to return in your search. Can be file, folder, or web_link.

 

Trash Content

String

Allows you to search within the trash. Can be trashed_only or non_trashed_only. Searches without this parameter default to non_trashed_only.

 

Mdfilters

String

Filters for a specific metadata template for files with metadata object associations. The filters are to be placed in a single JSON object. Please refer the MDFilters object in the definitions section of the swagger.json

 

Limit

Number

Number of search results to return. The default is 30 and the max is 200.

 

Offset

Number

The search result at which to start the response. The default is 0.

 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Update Collaboration

<box-connector:update-collaboration>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Update Collaboration Request Data

Any

#[payload]

 

Collab Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Update Comment

<box-connector:update-comment>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Update Comment Request Data

Any

#[payload]

 

Fields

String

Attribute(s) to include in the response.

 

Comment Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Update File Info

<box-connector:update-file-info>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Update File Info Request Data

Any

#[payload]

 

File Id

String

x 

If Match

String

The etag of the file can be included as an ‘If-Match’ header to prevent race conditions.

 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Update Folder

<box-connector:update-folder>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Update Folder Request Data

Any

#[payload]

 

Fields

String

Attribute(s) to include in the response

 

Folder Id

String

x 

If Match

String

This is in the ‘etag’ field of the folder object.

 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Update Group Membership

<box-connector:update-group-membership>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Update Group Membership Request Data

Any

#[payload]

 

Fields

String

Attribute(s) to include in the response

 

Group Membership Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Update Task

<box-connector:update-task>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x 

Update Task Request Data

Any

#[payload]

 

Fields

String

Attribute(s) to include in the response

 

Task Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Update Task Assignment

<box-connector:update-task-assignment>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Update Task Assignment Request Data

Any

#[payload]

 

Task Assignment Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Update User

<box-connector:update-user>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Update User Request Data

Any

#[payload]

 

Fields

String

Attribute(s) to include in the response

 

User Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Update User Folder

<box-connector:update-user-folder>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x 

Update User Folder Request Data

Any

#[payload]

 

Notify

Boolean

 

Fields

String

Attribute(s) to include in the response

 

User Id

String

x 

Folder Id

String

x 

Request streaming mode

Enumeration, one of:

  • AUTO

  • NEVER

  • ALWAYS

 

Target Variable

String

Name of a variable in which to store the operation’s output

 

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

 

Output

Type

Any

For Configurations.

Throws

  • BOX-CONNECTOR:TIMEOUT  

  • BOX-CONNECTOR:RETRY_EXHAUSTED  

  • BOX-CONNECTOR:PARSING  

  • BOX-CONNECTOR:FORBIDDEN  

  • BOX-CONNECTOR:NOT_ACCEPTABLE  

  • BOX-CONNECTOR:SERVICE_UNAVAILABLE  

  • BOX-CONNECTOR:METHOD_NOT_ALLOWED  

  • BOX-CONNECTOR:TOO_MANY_REQUESTS  

  • BOX-CONNECTOR:UNSUPPORTED_MEDIA_TYPE  

  • BOX-CONNECTOR:INTERNAL_SERVER_ERROR  

  • BOX-CONNECTOR:NOT_FOUND  

  • BOX-CONNECTOR:UNAUTHORIZED  

  • BOX-CONNECTOR:CONNECTIVITY  

  • BOX-CONNECTOR:BAD_REQUEST  

  • BOX-CONNECTOR:SECURITY  

Types

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance can remain idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute