Contact Us 1-800-596-4880
  1. Homepage
  2. Box Connector (5.2)

  3. Box Connector Reference

All Connectors

Box Connector Reference 5.2 - Mule 4

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

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 is 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

Response Timeout

Number

The timeout for request to the remote service.

1

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

MINUTES

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

AUTO

Name

String

The identifier of this element used to reference it in other components

X

Expiration Policy

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

JWT
Name Type Description Default Value Required

Default Headers

Array of Default Header

Query Parameters

Array of Default Query Param

Connection Timeout

Number

The timeout for establishing connections to the remote service

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit which qualifies the Connection Timeout.

SECONDS

Use Persistent Connections

Boolean

If false, each connection will be closed after the first request is completed.

true

Max Connections

Number

The maximum number of outbound connections that will be kept open at the same time

-1

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the connection Idle Timeout.

SECONDS

Proxy Config

Proxy

Reusable configuration element for outbound connections through a proxy

Stream Response

Boolean

Whether or not received responses should be streamed

false

Response Buffer Size

Number

The space in bytes for the buffer where the HTTP response will be stored.

-1

Client ID

String

X

Client Secret

String

X

Public Key Id

String

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

X

Entity Id

String

The type of the Entity ID: EnterpriseId or UserId

X

Box Sub Type

Enumeration, one of:

  • ENTERPRISE

  • USER

The box sub type: enterprise or user

X

Algorithm

Enumeration, one of:

  • RS256

  • RS384

  • RS512

The RSA encryption algorithm used to encrypt the private key.

X

Keystore

String

Path to keystore

X

Keystore Type

Enumeration, one of:

  • JKS

  • PKCS12

Keystore type: JKS or PKCS12

X

Store Password

String

Password of key store

X

Key Alias

String

Alias which identifies the key

X

Key Password

String

Key password

X

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy
Oauth2security Connection Provider

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.

Parameters
Name Type Description Default Value Required

Default Headers

Array of Default Header

Query Parameters

Array of Default Query Param

Connection Timeout

Number

The timeout for establishing connections to the remote service

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit which qualifies the Connection Timeout.

SECONDS

Use Persistent Connections

Boolean

If false, each connection is closed after the first request is completed.

true

Max Connections

Number

Maximum number of outbound connections to keep open concurrently.

-1

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit which qualifies the connection Idle Timeout.

SECONDS

Proxy Config

Proxy

Reusable configuration element for outbound connections through a proxy.

Stream Response

Boolean

Whether or not to stream received responses.

false

Response Buffer Size

Number

The space in bytes for the buffer where the HTTP response is stored.

-1

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS.

HTTP

TLS Configuration

Tls

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Consumer Key

String

The OAuth consumerKey, as registered with the service provider.

X

Consumer Secret

String

The OAuth consumerSecret, as registered with the service provider.

X

Authorization Url

String

Service provider’s authorization endpoint URL

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

Access Token Url

String

The service provider’s accessToken endpoint URL

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

Scopes

String

The OAuth scopes to request during the OAuth dance. If not provided, the values default to those in the annotation.

  • root_readwrite

  • manage_app_users

  • manage_managed_users

  • manage_groups

  • manage_webhook

Resource Owner Id

String

Resource owner ID each component should use if the resource owner ID is not otherwise referenced.

Before

String

The name of a flow to execute immediately before starting the OAuth dance.

After

String

The name of a flow to execute immediately after an access token is received.

Listener Config

String

A reference to an <http:listener-config /> to use to create the listener that will receive the access token callback endpoint.

X

Callback Path

String

The path of the access token callback endpoint

X

Authorize Path

String

The path of the local http endpoint which triggers the OAuth dance

X

External Callback Url

String

If the callback endpoint is behind a proxy or should be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL it should use to access the callback

Object Store

String

A reference to the object store to use to store each resource owner ID’s data. If not specified, Mule automatically provisions the default object store.

Associated Operations

Associated Sources

Operations

Add domain to list of allowed collaboration domains

<box:create-collaboration-whitelist-entries>

Creates a new entry in the list of domains allowed to collaborate. This operation makes an HTTP POST request to the /collaboration_whitelist_entries endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create user exemption from collaboration domain restrictions

<box:create-collaboration-whitelist-exempt-targets>

Exempts a user from the restrictions set out by the allowed list of domains for collaborations. This operation makes an HTTP POST request to the /collaboration_whitelist_exempt_targets endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create collaboration

<box:create-collaborations>

Adds a collaboration for a single user or a single group to a file or folder. Collaborations can be created using email address, user IDs, or a group IDs. If a collaboration is being created with a group, access to this endpoint is dependent on the group’s ability to be invited. This operation makes an HTTP POST request to the /collaborations endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

notify

Boolean

Determines if users should receive email notification for the action performed.

false

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create comment

<box:create-comments>

Adds a comment by the user to a specific file, or as a reply to an other comment. This operation makes an HTTP POST request to the /comments endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Copy file request

<box:create-file-requests-copy-by-file-request-id>

Copies an existing file request that is present on one folder, and applies it to another folder. This operation makes an HTTP POST request to the /file_requests/{file_request_id}/copy endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File request id

String

The unique identifier that represents a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/filerequest/123 the file_request_id is 123.

X

Body

String

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

Timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Restore file

<box:create-files-by-file-id>

Restores a file that was moved to the trash. An optional new parent ID can be provided to restore the file to in case the original folder has been deleted. This operation makes an HTTP POST request to the /files/{file_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File id

String

The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Upload file

<box:create-files-content>

Uploads a small file to Box. For file sizes over 50MB, use the Chunk Upload APIs.

In the Request body, the attributes part of the body must come before the file part. Requests that do not follow this format when uploading the file will receive an HTTP 400 error with a metadata_after_file_contents error code.

This operation makes an HTTP POST request to the /files/content endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Content md5

String

An optional header containing the SHA1 hash of the file to ensure that the file was not corrupted in transit.

Attributes - Body

Any

The content of the 'attributes' part.

#[payload]

File - Body

String

The content of the 'file' part.

X

file Filename

String

The filename of the 'file' part (just the name, do not include path).

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Upload file version

<box:create-files-content-by-file-id>

Updates a file’s content. For file sizes over 50MB, use the Chunk Upload APIs.

For the Request body order, the attributes part of the body must come before the file part. Requests that do not follow this format when uploading the file will receive an HTTP 400 error with a metadata_after_file_contents error code.

This operation makes an HTTP POST request to the /files/{file_id}/content endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File id

String

The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

If match

String

Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed etag value into this header and the endpoint will fail with a 412 Precondition Failed if it has changed since.

Content md5

String

An optional header containing the SHA1 hash of the file to ensure that the file was not corrupted in transit.

Attributes - Body

Any

The content of the 'attributes' part.

#[payload]

File - Body

String

The content of the 'file' part.

X

file Filename

String

The filename of the 'file' part. Do not include the path; use only the file name.

X

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Copy file

<box:create-files-copy-by-file-id>

Creates a copy of a file. This operation makes an HTTP POST request to the /files/{file_id}/copy endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File id

String

The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create metadata instance on file

<box:create-files-metadata-by-file-id-scope-template-key>

Applies an instance of a metadata template to a file. In most cases only values that are present in the metadata template will be accepted, with the exception of the global.properties template, which accepts any key-value pair.

This operation makes an HTTP POST request to the /files/{file_id}/metadata/{scope}/{template_key} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File id

String

The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

X

scope

Enumeration, one of:

  • GLOBAL

  • ENTERPRISE

The scope of the metadata template

X

Template key

String

The name of the metadata template

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Add classification to file

<box:create-files-metadata-enterprise-security-classification6vmvochw-uwo-by-file-id>

Adds a classification to a file by specifying the label of the classification to add. This API can also be called by including the enterprise ID in the URL explicitly, for example /files/:id//enterprise_12345/securityClassification-6VMVochwUWo.

This operation makes an HTTP POST request to the /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File id

String

The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create Box Skill cards on file

<box:create-files-metadata-global-box-skills-cards-by-file-id>

Applies one or more Box Skills metadata cards to a file. This operation makes an HTTP POST request to the /files/{file_id}/metadata/global/boxSkillsCards endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File id

String

The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create upload session

<box:create-files-upload-sessions>

Creates an upload session for a new file. This operation makes an HTTP POST request to the /files/upload_sessions endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create upload session for existing file

<box:create-files-upload-sessions-by-file-id>

Creates an upload session for an existing file. This operation makes an HTTP POST request to the /files/{file_id}/upload_sessions endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File id

String

The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for requests to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Commit upload session

<box:create-files-upload-sessions-commit-by-upload-session-id>

Closes an upload session and create a file from the uploaded chunks. This operation makes an HTTP POST request to the /files/upload_sessions/{upload_session_id}/commit endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Upload session id

String

The ID of the upload session.

X

digest

String

The [RFC3230][1] message digest of the whole file. Only SHA1 is supported. The SHA1 digest must be Base64 encoded. The format of this header is as sha=BASE64_ENCODED_DIGEST. [1]: https://tools.ietf.org/html/rfc3230

X

If match

String

Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed etag value into this header and the endpoint will fail with a 412 Precondition Failed if it has changed since.

If none match

String

Ensures an item is only returned if it has changed. Pass in the item’s last observed etag value into this header and the endpoint will fail with a 304 Not Modified if the item has not changed since.

Body

Any

Content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for requests to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Revert file version

<box:create-files-versions-current-by-file-id>

Reverts to a previous version of a file. If previous versions exist, this method can be used to promote one of the older versions to the top of the version history. This creates a new copy of the old version of the file and puts it at the top of the versions history. The file will have the exact same contents as the older version, with the the same hash digest, etag, and name as the original. Other properties, such as comments do not get updated to their former values.

This operation makes an HTTP POST request to the /files/{file_id}/versions/current endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File id

String

The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create folder lock on folder

<box:create-folder-locks>

Creates a folder lock on a folder, preventing it from being moved and/or deleted. This operation makes an HTTP POST request to the /folder_locks endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

Content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create folder

<box:create-folders>

Creates a new empty folder within the specified parent folder. This operation makes an HTTP POST request to the /folders endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Restore folder

<box:create-folders-by-folder-id>

Restores a folder that has been moved to the trash. An optional new parent ID can be provided to restore the folder to in case the original folder has been deleted.

Folder locking

During this operation, part of the file tree will be locked, mainly the source folder and all of its descendants, as well as the destination folder. For the duration of the operation, no other move, copy, delete, or restore operation can performed on any of the locked folders.

This operation makes an HTTP POST request to the /folders/{folder_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Folder id

String

The unique identifier that represents a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Copy folder

<box:create-folders-copy-by-folder-id>

Creates a copy of a folder within a destination folder. The original folder will not be changed. This operation makes an HTTP POST request to the /folders/{folder_id}/copy endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Folder id

String

The unique identifier of the folder to copy. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder with the ID 0 can not be copied.

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create metadata instance on folder

<box:create-folders-metadata-by-folder-id-scope-template-key>

Applies an instance of a metadata template to a folder. In most cases, only values that are present in the metadata template will be accepted, with the exception of the global.properties template, which accepts any key-value pair.

To display the metadata template in the Box web app, the enterprise must be configured to enable Cascading Folder Level Metadata for the user in the admin console.

This operation makes an HTTP POST request to the /folders/{folder_id}/metadata/{scope}/{template_key} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Folder id

String

The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.

X

scope

Enumeration, one of:

  • GLOBAL

  • ENTERPRISE

The scope of the metadata template

X

Template key

String

The name of the metadata template

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Add classification to folder

<box:create-folders-metadata-enterprise-security-classification6vmvochwUwo-by-folder-id>

Adds a classification to a folder by specifying the label of the classification to add. This API can also be called by including the enterprise ID in the URL explicitly, for example /folders/:id//enterprise_12345/securityClassification-6VMVochwUWo.

This operation makes an HTTP POST request to the /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Folder id

String

The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Add user to group

<box:create-group-memberships>

Creates a group membership. Only users with admin-level permissions will be able to use this API. This operation makes an HTTP POST request to the /group_memberships endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create group

<box:create-groups>

Creates a new group of users in an enterprise. Only users with admin permissions can create new groups. This operation makes an HTTP POST request to the /groups endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create user invite

<box:create-invites>

Invites an existing external user to join an enterprise. The existing user can not be part of another enterprise and must already have a Box account. Once invited, the user will receive an email and are prompted to accept the invitation within the Box web application. This method requires the "Manage An Enterprise" scope enabled for the application, which can be enabled within the developer console. This operation makes an HTTP POST request to the /invites endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create legal hold policy

<box:create-legal-hold-policies>

Create a new legal hold policy. This operation makes an HTTP POST request to the /legal_hold_policies endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Assign legal hold policy

<box:create-legal-hold-policy-assignments>

Assigns a legal hold to a file, file version, folder, or user. This operation makes an HTTP POST request to the /legal_hold_policy_assignments endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create metadata cascade policy

<box:create-metadata-cascade-policies>

Creates a new metadata cascade policy that applies a given metadata template to a given folder and automatically cascades it down to any files within that folder. In order for the policy to be applied a metadata instance must first be applied to the folder the policy is to be applied to. This operation makes an HTTP POST request to the /metadata_cascade_policies endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Force-apply metadata cascade policy to folder

<box:create-metadata-cascade-policies-apply-by-metadata-cascade-policy-id>

Forces the metadata on a folder with a metadata cascade policy to be applied to all of its children. This can be used after creating a new cascade policy to enforce the metadata to be cascaded down to all existing files within that folder.

This operation makes an HTTP POST request to the /metadata_cascade_policies/{metadata_cascade_policy_id}/apply endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Metadata cascade policy id

String

The ID of the cascade policy to force-apply.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Query files and folders by metadata

<box:create-metadata-queries-execute-read>

Create a search using SQL-like syntax to return items that match specific metadata. By default, this endpoint returns only the most basic info about the items for which the query matches. To get additional fields for each item, including any of the metadata, use the fields attribute in the query. This operation makes an HTTP POST request to the /metadata_queries/execute_read endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create metadata template

<box:create-metadata-templates-schema>

Creates a new metadata template that can be applied to files and folders. This operation makes an HTTP POST request to the /metadata_templates/schema endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Add initial classifications

<box:create-metadata-templates-schemaclassifications>

When an enterprise does not yet have any classifications, this API call initializes the classification template with an initial set of classifications. If an enterprise already has a classification, the template will already exist and instead an API call should be made to add additional classifications.

This operation makes an HTTP POST request to the /metadata_templates/schema#classifications endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create retention policy

<box:create-retention-policies>

Creates a retention policy. This operation makes an HTTP POST request to the /retention_policies endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Assign retention policy

<box:create-retention-policy-assignments>

Assigns a retention policy to an item. This operation makes an HTTP POST request to the /retention_policy_assignments endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Assign storage policy

<box:create-storage-policy-assignments>

Creates a storage policy assignment for an enterprise or user. This operation makes an HTTP POST request to the /storage_policy_assignments endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Assign task

<box:create-task-assignments>

Assigns a task to a user. A task can be assigned to more than one user by creating multiple assignments. This operation makes an HTTP POST request to the /task_assignments endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create task

<box:create-tasks>

Creates a single task on a file. This task is not assigned to any user and will need to be assigned separately. This operation makes an HTTP POST request to the /tasks endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create terms of service status for new user

<box:create-terms-of-service-user-statuses>

Sets the status for a terms of service for a user. This operation makes an HTTP POST request to the /terms_of_service_user_statuses endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create terms of service

<box:create-terms-of-services>

Creates a terms of service for a given enterprise and type of user. This operation makes an HTTP POST request to the /terms_of_services endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create user

<box:create-users>

Creates a new managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions. This operation makes an HTTP POST request to the /users endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create email alias

<box:create-users-email-aliases-by-user-id>

Adds a new email alias to a user account. This operation makes an HTTP POST request to the /users/{user_id}/email_aliases endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

User id

String

The ID of the user.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

<box:create-web-links>

Creates a web link object within a folder. This operation makes an HTTP POST request to the /web_links endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Restore web link

<box:create-web-links-by-web-link-id>

Restores a web link that has been moved to the trash. An optional new parent ID can be provided to restore the web link in case the original folder has been deleted.

This operation makes an HTTP POST request to the /web_links/{web_link_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Web link id

String

The ID of the web link.

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create webhook

<box:create-webhooks>

Creates a webhook. This operation makes an HTTP POST request to the /webhooks endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create zip download

<box:create-zip-downloads>

Creates a request to download multiple files and folders as a single zip archive file. This API does not return the archive but instead performs all the checks to ensure that the user has access to all the items, and then returns a download_url and a status_url that can be used to download the archive. The limit for an archive is either 32GB or 10,000 files, whichever limitation is met first.

This operation makes an HTTP POST request to the /zip_downloads endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Body

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove domain from list of allowed collaboration domains

<box:delete-collaboration-whitelist-entries-by-collaboration-whitelist-entry-id>

Removes a domain from the list of domains that have been deemed safe to create collaborations for within the current enterprise. This operation makes an HTTP DELETE request to the /collaboration_whitelist_entries/{collaboration_whitelist_entry_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Collaboration whitelist entry id

String

The ID of the entry in the list.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove user from list of users exempt from domain restrictions

<box:delete-collaboration-whitelist-exempt-targets-by-collaboration-whitelist-exempt-target-id>

Removes a user’s exemption from the restrictions set out by the allowed list of domains for collaborations. This operation makes an HTTP DELETE request to the /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Collaboration whitelist exempt target id

String

The ID of the exemption to the list.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove collaboration

<box:delete-collaborations-by-collaboration-id>

Deletes a single collaboration. This operation makes an HTTP DELETE request to the /collaborations/{collaboration_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Collaboration id

String

The ID of the collaboration

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove comment

<box:delete-comments-by-comment-id>

Permanently deletes a comment. This operation makes an HTTP DELETE request to the /comments/{comment_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Comment id

String

The ID of the comment.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove device pin

<box:delete-device-pinners-by-device-pinner-id>

Deletes an individual device pin. This operation makes an HTTP DELETE request to the /device_pinners/{device_pinner_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Device pinner id

String

The ID of the device pin

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Delete file request

<box:delete-file-requests-by-file-request-id>

Deletes a file request permanently. This operation makes an HTTP DELETE request to the /file_requests/{file_request_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File request id

String

The unique identifier that represents a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/filerequest/123 the file_request_id is 123.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Delete file

<box:delete-files-by-file-id>

Deletes a file, either permanently or by moving it to the trash. The enterprise settings determine whether the item will be permanently deleted from Box or moved to the trash.

This operation makes an HTTP DELETE request to the /files/{file_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File id

String

The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

X

If match

String

Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed etag value into this header and the endpoint will fail with a 412 Precondition Failed if it has changed since.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove metadata instance from file

<box:delete-files-metadata-by-file-id-scope-template-key>

Deletes a piece of file metadata. This operation makes an HTTP DELETE request to the /files/{file_id}/metadata/{scope}/{template_key} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File id

String

The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

X

scope

Enumeration, one of:

  • GLOBAL

  • ENTERPRISE

The scope of the metadata template

X

Template key

String

The name of the metadata template

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove classification from file

<box:delete-files-metadata-enterprise-security-classification-by-file-id>

Removes any classifications from a file. This API can also be called by including the enterprise ID in the URL explicitly, for example /files/:id//enterprise_12345/securityClassification-6VMVochwUWo.

This operation makes an HTTP DELETE request to the /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File id

String

The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove Box Skill cards from file

<box:delete-files-metadata-global-box-skills-cards-by-file-id>

Removes any Box Skills cards metadata from a file. This operation makes an HTTP DELETE request to the /files/{file_id}/metadata/global/boxSkillsCards endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File id

String

The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Permanently remove file

<box:delete-files-trash-by-file-id>

Permanently deletes a file that is in the trash. This action cannot be undone. This operation makes an HTTP DELETE request to the /files/{file_id}/trash endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File id

String

The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove upload session

<box:delete-files-upload-sessions-by-upload-session-id>

Abort an upload session and discard all data uploaded. This cannot be reversed. This operation makes an HTTP DELETE request to the /files/upload_sessions/{upload_session_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Upload session id

String

The ID of the upload session.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove file version

<box:delete-files-versions-by-file-id-file-version-id>

Moves a file version to the trash. Versions are only tracked for Box users with premium accounts. This operation makes an HTTP DELETE request to the /files/{file_id}/versions/{file_version_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File id

String

The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

X

File version id

String

The ID of the file version

X

If match

String

Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed etag value into this header and the endpoint will fail with a 412 Precondition Failed if it has changed since.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove watermark from file

<box:delete-files-watermark-by-file-id>

Removes the watermark from a file. This operation makes an HTTP DELETE request to the /files/{file_id}/watermark endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File id

String

The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Delete folder lock

<box:delete-folder-locks-by-folder-lock-id>

Deletes a folder lock on a given folder. This operation makes an HTTP DELETE request to the /folder_locks/{folder_lock_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Folder lock id

String

The ID of the folder lock.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Delete folder

<box:delete-folders-by-folder-id>

Deletes a folder, either permanently or by moving it to the trash. This operation makes an HTTP DELETE request to the /folders/{folder_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Folder id

String

The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.

X

recursive

Boolean

Delete a folder that is not empty by recursively deleting the folder and all of its content.

false

If match

String

Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed etag value into this header and the endpoint will fail with a 412 Precondition Failed if it has changed since.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove metadata instance from folder

<box:delete-folders-metadata-by-folder-id-scope-template-key>

Deletes a piece of folder metadata. This operation makes an HTTP DELETE request to the /folders/{folder_id}/metadata/{scope}/{template_key} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Folder id

String

The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.

X

scope

Enumeration, one of:

  • GLOBAL

  • ENTERPRISE

The scope of the metadata template

X

Template key

String

The name of the metadata template

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove classification from folder

<box:delete-folders-metadata-enterprise-security-classification6vmvochw-uwo-by-folder-id>

Removes any classifications from a folder. This API can also be called by including the enterprise ID in the URL explicitly, for example /folders/:id//enterprise_12345/securityClassification-6VMVochwUWo.

This operation makes an HTTP DELETE request to the /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Folder id

String

The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Permanently remove folder

<box:delete-folders-trash-by-folder-id>

Permanently deletes a folder that is in the trash. This action cannot be undone. This operation makes an HTTP DELETE request to the /folders/{folder_id}/trash endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Folder id

String

The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove watermark from folder

<box:delete-folders-watermark-by-folder-id>

Removes the watermark from a folder. This operation makes an HTTP DELETE request to the /folders/{folder_id}/watermark endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Folder id

String

The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove user from group

<box:delete-group-memberships-by-group-membership-id>

Deletes a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API. This operation makes an HTTP DELETE request to the /group_memberships/{group_membership_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Group membership id

String

The ID of the group membership.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove group

<box:delete-groups-by-group-id>

Permanently deletes a group. Only users with admin-level permissions will be able to use this API. This operation makes an HTTP DELETE request to the /groups/{group_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Group id

String

The ID of the group.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove legal hold policy

<box:delete-legal-hold-policies-by-legal-hold-policy-id>

Delete an existing legal hold policy. This is an asynchronous process. The policy will not be fully deleted yet when the response returns. This operation makes an HTTP DELETE request to the /legal_hold_policies/{legal_hold_policy_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Legal hold policy id

String

The ID of the legal hold policy

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Unassign legal hold policy

<box:delete-legal-hold-policy-assignments-by-legal-hold-policy-assignment-id>

Removes a legal hold from an item. This is an asynchronous process. The policy will not be fully removed yet when the response returns. This operation makes an HTTP DELETE request to the /legal_hold_policy_assignments/{legal_hold_policy_assignment_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Legal hold policy assignment id

String

The ID of the legal hold policy assignment

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove metadata cascade policy

<box:delete-metadata-cascade-policies-by-metadata-cascade-policy-id>

Deletes a metadata cascade policy. This operation makes an HTTP DELETE request to the /metadata_cascade_policies/{metadata_cascade_policy_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Metadata cascade policy id

String

The ID of the metadata cascade policy.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Delete all classifications

<box:delete-metadata-templates-enterprise-security-classification6vmvochw-uwo-schema>

Deletes all classifications by deleting the classification metadata template. This operation makes an HTTP DELETE request to the /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove metadata template

<box:delete-metadata-templates-schema-by-scope-template-key>

Deletes a metadata template and its instances. This deletion is permanent and can not be reversed. This operation makes an HTTP DELETE request to the /metadata_templates/{scope}/{template_key}/schema endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

scope

Enumeration, one of:

  • GLOBAL

  • ENTERPRISE

The scope of the metadata template

X

Template key

String

The name of the metadata template

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Unassign storage policy

<box:delete-storage-policy-assignments-by-storage-policy-assignment-id>

Deletes a storage policy assignment. Deleting a storage policy assignment on a user will have the user inherit the enterprise’s default storage policy. There is a rate limit for calling this endpoint of only twice per user in a 24 hour time frame. This operation makes an HTTP DELETE request to the /storage_policy_assignments/{storage_policy_assignment_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Storage policy assignment id

String

The ID of the storage policy assignment.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Unassign task

<box:delete-task-assignments-by-task-assignment-id>

Deletes a specific task assignment. This operation makes an HTTP DELETE request to the /task_assignments/{task_assignment_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Task assignment id

String

The ID of the task assignment.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove task

<box:delete-tasks-by-task-id>

Removes a task from a file. This operation makes an HTTP DELETE request to the /tasks/{task_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Task id

String

The ID of the task.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Delete user

<box:delete-users-by-user-id>

Deletes a user. By default, this operation will fail if the user still owns any content. Move the user’s owned content before proceeding, or use the force field to delete the user and their files. This operation makes an HTTP DELETE request to the /users/{user_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

User id

String

The ID of the user.

X

notify

Boolean

Whether the user will receive email notification of the deletion

false

force

Boolean

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

false

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove email alias

<box:delete-users-email-aliases-by-user-id-email-alias-id>

Removes an email alias from a user. This operation makes an HTTP DELETE request to the /users/{user_id}/email_aliases/{email_alias_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

User id

String

The ID of the user.

X

Email alias id

String

The ID of the email alias.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove web link

<box:delete-web-links-by-web-link-id>

Deletes a web link. This operation makes an HTTP DELETE request to the /web_links/{web_link_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Web link id

String

The ID of the web link.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Permanently remove web link

<box:delete-web-links-trash-by-web-link-id>

Permanently deletes a web link that is in the trash. This action cannot be undone. This operation makes an HTTP DELETE request to the /web_links/{web_link_id}/trash endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Web link id

String

The ID of the web link.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove webhook

<box:delete-webhooks-by-webhook-id>

Deletes a webhook. This operation makes an HTTP DELETE request to the /webhooks/{webhook_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Webhook id

String

The ID of the webhook.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List allowed collaboration domains

<box:get-collaboration-whitelist-entries>

Returns the list of domains that are deemed safe to create collaborations for within the current enterprise. This operation makes an HTTP GET request to the /collaboration_whitelist_entries endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

marker

String

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.

limit

Number

The maximum number of items to return per page.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of * Any

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get allowed collaboration domain

<box:get-collaboration-whitelist-entries-by-collaboration-whitelist-entry-id>

Returns a domain that has been deemed safe to create collaborations for within the current enterprise. This operation makes an HTTP GET request to the /collaboration_whitelist_entries/{collaboration_whitelist_entry_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Collaboration whitelist entry id

String

The ID of the entry in the list.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List users exempt from collaboration domain restrictions

<box:get-collaboration-whitelist-exempt-targets>

Returns a list of users who are exempt from the collaboration domain restrictions. This operation makes an HTTP GET request to the /collaboration_whitelist_exempt_targets endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

marker

String

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.

limit

Number

The maximum number of items to return per page.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of * Any

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get user exempt from collaboration domain restrictions

<box:get-collaboration-whitelist-exempt-targets-by-collaboration-whitelist-exempt-target-id>

Returns a user who is exempt from the collaboration domain restrictions.

This operation makes an HTTP GET request to the /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Collaboration whitelist exempt target id

String

The ID of the exemption to the list.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List pending collaborations

<box:get-collaborations>

Retrieves a list of all pending collaboration invites for this user. This operation makes an HTTP GET request to the /collaborations endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

status

Enumeration, one of:

  • PENDING

The status of the collaborations to retrieve

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

offset

Number

The offset of the item at which to begin the response.

0

limit

Number

The maximum number of items to return per page.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of * Any

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get collaboration

<box:get-collaborations-by-collaboration-id>

Retrieves a single collaboration. This operation makes an HTTP GET request to the /collaborations/{collaboration_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Collaboration id

String

The ID of the collaboration

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List all collections

<box:get-collections>

Retrieves a list of all collections for a given user. Currently, only the favorites collection is supported. This operation makes an HTTP GET request to the /collections endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

offset

Number

The offset of the item at which to begin the response.

0

limit

Number

The maximum number of items to return per page.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of * Any

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List collection items

<box:get-collections-items-by-collection-id>

Retrieves the files and folders contained within this collection. This operation makes an HTTP GET request to the /collections/{collection_id}/items endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Collection id

String

The ID of the collection.

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, in addition to the fields requested.

offset

Number

The offset of the item at which to begin the response.

0

limit

Number

The maximum number of items to return per page.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of * Any * Any * Any

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get comment

<box:get-comments-by-comment-id>

Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment. This operation makes an HTTP GET request to the /comments/{comment_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Comment id

String

The ID of the comment.

X

fields

Array of String

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get device pin

<box:get-device-pinners-by-device-pinner-id>

Retrieves information about an individual device pin. This operation makes an HTTP GET request to the /device_pinners/{device_pinner_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

X

Device pinner id

String

ID of the device pin

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List enterprise device pins

<box:get-enterprises-device-pinners-by-enterprise-id>

Retrieves a list of all the device pins within an enterprise. The user must have admin privileges, and the application needs the manage enterprise scope to make this call. This operation makes an HTTP GET request to the /enterprises/{enterprise_id}/device_pinners endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Enterprise id

String

The ID of the enterprise

X

marker

String

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.

limit

Number

The maximum number of items to return per page.

direction

Enumeration, one of:

  • ASC

  • DESC

The direction to sort results in. This can be either in alphabetical ascending (ASC) or descending (DESC) order.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of * Any

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List user and enterprise events

<box:get-events>

Returns up to a year of past events for a given user or for the entire enterprise. By default, this returns events for the authenticated user. To retrieve events for the entire enterprise, set the stream_type to admin_logs. The user making the API call must have admin privileges, and the application must have the permission to access the event feed to get the enterprise event feed. This operation makes an HTTP GET request to the /events endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Stream type

Enumeration, one of:

  • ALL

  • CHANGES

  • SYNC

  • ADMIN_LOGS

Defines the type of events that are returned * all returns everything for a user and is the default * changes returns events that may cause file tree changes such as file updates or collaborations. * sync is similar to changes but only applies to synced folders * admin_logs returns all events for an entire enterprise and requires the user making the API call to have admin permissions.

ALL

Stream position

String

The location in the event stream to start receiving events from. * now will return an empty list events and the latest stream position for initialization. * 0 or null will return all events.

limit

Number

Limits the number of events returned

100

Event type

Array of Enumeration, one of:

  • ACCESS_GRANTED

  • ACCESS_REVOKED

  • ADD_DEVICE_ASSOCIATION

  • ADD_LOGIN_ACTIVITY_DEVICE

  • ADMIN_LOGIN

  • APPLICATION_CREATED

  • APPLICATION_PUBLIC_KEY_ADDED

  • APPLICATION_PUBLIC_KEY_DELETED

  • CHANGE_ADMIN_ROLE

  • CHANGE_FOLDER_PERMISSION

  • COLLABORATION_ACCEPT

  • COLLABORATION_EXPIRATION

  • COLLABORATION_INVITE

  • COLLABORATION_REMOVE

  • COLLABORATION_ROLE_CHANGE

  • COMMENT_CREATE

  • COMMENT_DELETE

  • CONTENT_WORKFLOW_ABNORMAL_DOWNLOAD_ACTIVITY

  • CONTENT_WORKFLOW_AUTOMATION_ADD

  • CONTENT_WORKFLOW_AUTOMATION_DELETE

  • CONTENT_WORKFLOW_POLICY_ADD

  • CONTENT_WORKFLOW_SHARING_POLICY_VIOLATION

  • CONTENT_WORKFLOW_UPLOAD_POLICY_VIOLATION

  • COPY

  • DATA_RETENTION_CREATE_RETENTION

  • DATA_RETENTION_REMOVE_RETENTION

  • DELETE

  • DELETE_USER

  • DEVICE_TRUST_CHECK_FAILED

  • DOWNLOAD

  • EDIT

  • EDIT_USER

  • EMAIL_ALIAS_CONFIRM

  • EMAIL_ALIAS_REMOVE

  • ENTERPRISE_APP_AUTHORIZATION_UPDATE

  • EXTERNAL_COLLAB_SECURITY_SETTINGS

  • FAILED_LOGIN

  • FILE_MARKED_MALICIOUS

  • FILE_WATERMARKED_DOWNLOAD

  • GROUP_ADD_ITEM

  • GROUP_ADD_USER

  • GROUP_CREATION

  • GROUP_DELETION

  • GROUP_EDITED

  • GROUP_REMOVE_ITEM

  • GROUP_REMOVE_USER

  • ITEM_MODIFY

  • ITEM_OPEN

  • ITEM_SHARED_UPDATE

  • ITEM_SYNC

  • ITEM_UNSYNC

  • LEGAL_HOLD_ASSIGNMENT_CREATE

  • LEGAL_HOLD_ASSIGNMENT_DELETE

  • LEGAL_HOLD_POLICY_CREATE

  • LEGAL_HOLD_POLICY_DELETE

  • LEGAL_HOLD_POLICY_UPDATE

  • LOCK

  • LOGIN

  • METADATA_INSTANCE_CREATE

  • METADATA_INSTANCE_DELETE

  • METADATA_INSTANCE_UPDATE

  • METADATA_TEMPLATE_CREATE

  • METADATA_TEMPLATE_DELETE

  • METADATA_TEMPLATE_UPDATE

  • MOVE

  • NEW_USER

  • OAUTH2_ACCESS_TOKEN_REVOKE

  • PREVIEW

  • REMOVE_DEVICE_ASSOCIATION

  • REMOVE_LOGIN_ACTIVITY_DEVICE

  • RENAME

  • RETENTION_POLICY_ASSIGNMENT_ADD

  • SHARE

  • SHARE_EXPIRATION

  • SHIELD_ALERT

  • STORAGE_EXPIRATION

  • TASK_ASSIGNMENT_CREATE

  • TASK_ASSIGNMENT_DELETE

  • TASK_ASSIGNMENT_UPDATE

  • TASK_CREATE

  • TASK_UPDATE

  • TERMS_OF_SERVICE_ACCEPT

  • TERMS_OF_SERVICE_REJECT

  • UNDELETE

  • UNLOCK

  • UNSHARE

  • UPDATE_COLLABORATION_EXPIRATION

  • UPDATE_SHARE_EXPIRATION

  • UPLOAD

  • USER_AUTHENTICATE_OAUTH2_ACCESS_TOKEN_CREATE

  • WATERMARK_LABEL_CREATE

  • WATERMARK_LABEL_DELETE

A comma-separated list of events to filter by. This can only be used when requesting the events with a stream_type of admin_logs. For any other stream_type this value will be ignored.

Created after

String

The lower bound date and time to return events for. This can only be used when requesting the events with a stream_type of admin_logs. For any other stream_type this value will be ignored.

Created before

String

The upper bound date and time to return events for. This can only be used when requesting the events with a stream_type of admin_logs. For any other stream_type this value will be ignored.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get file request

<box:get-file-requests-by-file-request-id>

Retrieves the information about a file request. This operation makes an HTTP GET request to the /file_requests/{file_request_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File request id

String

The unique identifier that represents a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/filerequest/123 the file_request_id is 123.

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List file version legal holds

<box:get-file-version-legal-holds>

Gets a list of file versions on legal hold for a legal hold assignment. Due to ongoing rearchitecture efforts, this API might not return all file versions for this policy ID. Instead, this API will only return file versions held in the legacy architecture.

Two new endpoints are available to request any file versions held in the new architecture. For file versions held in the new architecture, the GET /legal_hold_policy_assignments/:id/file_versions_on_hold API can be used to return all past file versions available for this policy assignment, and the GET /legal_hold_policy_assignments/:id/files_on_hold API can be used to return any current (latest) versions of a file under legal hold. The GET /legal_hold_policy_assignments?policy_id={id} API can be used to find a list of policy assignments for a given policy ID. After the rearchitecture is completed, this API will be deprecated.

This operation makes an HTTP GET request to the /file_version_legal_holds endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

Policy id

String

The ID of the legal hold policy to get the file version legal holds for.

X

marker

String

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.

limit

Number

The maximum number of items to return per page.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

X

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of * Any

For Configurations

Throws

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get file version legal hold

<box:get-file-version-legal-holds-by-file-version-legal-hold-id>

Retrieves information about the legal hold policies assigned to a file version. This operation makes an HTTP GET request to the /file_version_legal_holds/{file_version_legal_hold_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

X

File version legal hold id

String

The ID of the file version legal hold

X

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.