Box Connector Reference 5.3 | MuleSoft Documentation
| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 | The name of the configuration to use.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 | The name of the configuration to use.  
Enumeration, one of:
  * GLOBAL
  * ENTERPRISE

| The scope of the metadata template  
Template key | The name of the metadata template  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 | The name of the configuration to use.  
Storage policy assignment id | The ID of the storage policy assignment.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 | The name of the configuration to use.  
Task assignment id | The ID of the task assignment.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER
## 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 | The name of the configuration to use.  
Task assignment id | The ID of the task assignment.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 | The name of the configuration to use.  
The ID of the task.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 | The name of the configuration to use.  
The ID of the user.  
Whether the user will receive email notification of the deletion  
Whether the user should be deleted even if this user still own files  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 | The name of the configuration to use.  
The ID of the user.  
Email alias id | The ID of the email alias.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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
| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 | The name of the configuration to use.  
Web link id | The ID of the web link.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 | The name of the configuration to use.  
Web link id | The ID of the web link.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 | The name of the configuration to use.  
Webhook id | The ID of the webhook.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 | The name of the configuration to use.  
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`.  
The maximum number of items to return per page.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER
| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 | The name of the configuration to use.  
Collaboration whitelist entry id | The ID of the entry in the list.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 | The name of the configuration to use.  
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`.  
The maximum number of items to return per page.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 | The name of the configuration to use.  
Collaboration whitelist exempt target id | The ID of the exemption to the list.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### Output
**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
| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### Output
**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 | The name of the configuration to use.  
Enumeration, one of: | The status of the collaborations to retrieve  
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.  
The offset of the item at which to begin the response.  
The maximum number of items to return per page.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 | The name of the configuration to use.  
Collaboration id | The ID of the collaboration  
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.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 | The name of the configuration to use.  
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.  
The offset of the item at which to begin the response.  
The maximum number of items to return per page.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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
| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 | The name of the configuration to use.  
Collection id | The ID of the collection.  
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.  
The offset of the item at which to begin the response.  
The maximum number of items to return per page.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 | The name of the configuration to use.  
Comment id | The ID of the comment.  
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.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 | Name of the configuration to use.  
Device pinner id | ID of the device pin  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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
| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 | The name of the configuration to use.  
Enterprise id | The ID of the enterprise  
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`.  
The maximum number of items to return per page.  
direction |  Enumeration, one of: | The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 | The name of the configuration to use.  
Stream type |  Enumeration, one of:
  * CHANGES
  * 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.  
Stream position | 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.  
Limits the number of events returned  
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
  * DATA_RETENTION_CREATE_RETENTION
  * DATA_RETENTION_REMOVE_RETENTION
  * DELETE
  * DELETE_USER
  * DEVICE_TRUST_CHECK_FAILED
  * DOWNLOAD
  * 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
  * LOGIN
  * METADATA_INSTANCE_CREATE
  * METADATA_INSTANCE_DELETE
  * METADATA_INSTANCE_UPDATE
  * METADATA_TEMPLATE_CREATE
  * METADATA_TEMPLATE_DELETE
  * METADATA_TEMPLATE_UPDATE
  * 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 | 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 | 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.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
| 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 | 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 | 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.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 | The name of the configuration to use.  
File request id | 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`.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 | The name of the configuration to use.  
Policy id | The ID of the legal hold policy to get the file version legal holds for.  
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`.  
The maximum number of items to return per page.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 | The name of the configuration to use.  
File version legal hold id | The ID of the file version legal hold  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER
## 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 | The name of the configuration to use.  
File version legal hold id | The ID of the file version legal hold  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 retentions
`<box:get-file-version-retentions>`
Retrieves all file version retentions for the given enterprise. This operation makes an HTTP GET request to the /file_version_retentions endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Filters results by files with this ID.  
File version id | Filters results by file versions with this ID.  
Policy id | Filters results by the retention policy with this ID.  
Disposition action |  Enumeration, one of:
  * PERMANENTLY_DELETE
  * REMOVE_RETENTION

| Filters results by the retention policy with this disposition action.  
Disposition before | Filters results by files that will have their disposition come into effect before this date.  
Disposition after | Filters results by files that will have their disposition come into effect after this date.  
The maximum number of items to return per page.  
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`.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 retention on file
`<box:get-file-version-retentions-by-file-version-retention-id>`
Returns information about a file version retention. This operation makes an HTTP GET request to the /file_version_retentions/{file_version_retention_id} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
File version retention id | The ID of the file version retention  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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
| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 information
`<box:get-files-by-file-id>`
Retrieves the details about a file. This operation makes an HTTP GET request to the /files/{file_id} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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`.  
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. Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example `?field=metadata.enterprise_12345.contractTemplate`.  
If none match | Ensures an item is returned only 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.  
The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly shared with a user. Use the format `shared_link=[link]` or if a password is required then use `shared_link=[link]&shared_link_password=[password]`. This header can be used on the file or folder shared, as well as on any files or folders nested within the item.  
X rep hints | A header required to request specific `representations` of a file. Use this in combination with the `fields` query parameter to request a specific file representation. The general format for these representations is `X-Rep-Hints: […​]` where `[…​]` is one or many hints in the format `[fileType?query]`. For example, to request a `png` representation in `32x32` as well as `94x94` pixel dimensions provide the following hints. `X-Rep-Hints: [jpg?dimensions=32x32][jpg?dimensions=94x94]` Additionally, a `text` representation is available for all document file types in Box using the `[extracted_text]` representation. `X-Rep-Hints: [extracted_text]`  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 collaborations
`<box:get-files-collaborations-by-file-id>`
Retrieves a list of pending and active collaborations for a file. This returns all the users that have access to the file or have been invited to the file. This operation makes an HTTP GET request to the /files/{file_id}/collaborations endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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`.  
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.  
The maximum number of items to return per page.  
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`.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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
| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 file comments
`<box:get-files-comments-by-file-id>`
Retrieves a list of comments for a file. This operation makes an HTTP GET request to the /files/{file_id}/comments endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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`.  
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.  
The maximum number of items to return per page.  
The offset of the item at which to begin the response.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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


## Download file
`<box:get-files-content-by-file-id>`
Returns the contents of a file in binary format. This operation makes an HTTP GET request to the /files/{file_id}/content endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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`.  
The file version to download  
Access token | An optional access token that can be used to pre-authenticate this request, which means that a download link can be shared with a browser or a third party service without them needing to know how to handle the authentication. When using this parameter, please make sure that the access token is sufficiently scoped down to only allow read access to that file and no other files or folders.  
The byte range of the content to download. The format `{start_byte}-{end_byte}` can be used to specify what section of the file to download.  
The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly shared with a user. Use the format `shared_link=[link]` or if a password is required then use `shared_link=[link]&shared_link_password=[password]`. This header can be used on the file or folder shared, as well as on any files or folders nested within the item.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 shared link for file
`<box:get-files-get-shared-link-by-file-id>`
Gets the information for a shared link on a file. This operation makes an HTTP GET request to the /files/{file_id}#get_shared_link endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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`.  
Explicitly request the `shared_link` fields to be returned for this item.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type** |  Http Response Attributes  
---|---  
### For Configurations
  *
| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 metadata instances on file
`<box:get-files-metadata-by-file-id>`
Retrieves all metadata for a given file. This operation makes an HTTP GET request to the /files/{file_id}/metadata endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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`.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 metadata instance on file
`<box:get-files-metadata-by-file-id-scope-template-key>`
Retrieves the instance of a metadata template that has been applied to a file. This operation makes an HTTP GET request to the /files/{file_id}/metadata/{scope}/{template_key} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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`.  
Enumeration, one of:
  * GLOBAL
  * ENTERPRISE

| The scope of the metadata template  
Template key | The name of the metadata template  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 classification on file
`<box:get-files-metadata-enterprise-security-classification6vmvochw-uwo-by-file-id>`
Retrieves the classification metadata instance that has been applied to 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 GET request to the /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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`.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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
| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 Box Skill cards on file
`<box:get-files-metadata-global-box-skills-cards-by-file-id>`
List the Box Skills metadata cards that are attached to a file. This operation makes an HTTP GET request to the /files/{file_id}/metadata/global/boxSkillsCards endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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`.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 tasks on file
`<box:get-files-tasks-by-file-id>`
Retrieves a list of all the tasks for a file. This endpoint does not support pagination. This operation makes an HTTP GET request to the /files/{file_id}/tasks endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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`.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 thumbnail
`<box:get-files-thumbnail-by-file-id-extension>`
Retrieves a thumbnail, or smaller image representation, of a file. Sizes of `32x32`,`64x64`, `128x128`, and `256x256` can be returned in the `.png` format and sizes of `32x32`, `94x94`, `160x160`, and `320x320` can be returned in the `.jpg` format.
This operation makes an HTTP GET request to the /files/{file_id}/thumbnail.{extension} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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`.  
extension |  Enumeration, one of: | The file format for the thumbnail  
Min height | The minimum height of the thumbnail  
Min width | The minimum width of the thumbnail  
Max height | The maximum height of the thumbnail  
Max width | The maximum width of the thumbnail  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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
| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 trashed file
`<box:get-files-trash-by-file-id>`
Retrieves a file that has been moved to the trash. The file can only be retrieved only if the file itself has been moved to the trash. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the [`GET /folders/:id/trash`](e://get_folders_id_trash) API. To list all items that have been moved to the trash, use the [`GET /folders/trash/items`](e://get-folders-trash-items/) API.
This operation makes an HTTP GET request to the /files/{file_id}/trash endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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`.  
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.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 upload session
`<box:get-files-upload-sessions-by-upload-session-id>`
Returns information about an upload session. This operation makes an HTTP GET request to the /files/upload_sessions/{upload_session_id} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Upload session id | The ID of the upload session.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 parts
`<box:get-files-upload-sessions-parts-by-upload-session-id>`
Returns a list of the chunks uploaded to the upload session so far. This operation makes an HTTP GET request to the /files/upload_sessions/{upload_session_id}/parts endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Upload session id | The ID of the upload session.  
The offset of the item at which to begin the response.  
The maximum number of items to return per page.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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
| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 all file versions
`<box:get-files-versions-by-file-id>`
Retrieves a list of the past versions for a file. Versions are only tracked by Box users with premium accounts. To fetch the ID of the current version of a file, use the `GET /file/:id` API. This operation makes an HTTP GET request to the /files/{file_id}/versions endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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`.  
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.  
The maximum number of items to return per page.  
The offset of the item at which to begin the response.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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
`<box:get-files-versions-by-file-id-file-version-id>`
Retrieves a specific version of a file. Versions are only tracked for Box users with premium accounts. This operation makes an HTTP GET request to the /files/{file_id}/versions/{file_version_id} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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`.  
File version id | The ID of the file version  
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.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 watermark on file
`<box:get-files-watermark-by-file-id>`
Retrieves the watermark for a file. This operation makes an HTTP GET request to the /files/{file_id}/watermark endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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`.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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
| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 folder locks on folder
`<box:get-folder-locks>`
Retrieves folder lock details for a given folder. This operation makes an HTTP GET request to the /folder_locks endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Folder id | 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 the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.  
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`.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 folder information
`<box:get-folders-by-folder-id>`
Retrieves details for a folder, including the first 100 entries in the folder. To fetch more items within the folder, use the [Get items in a folder](#get-folders-id-items) endpoint. This operation makes an HTTP GET request to the /folders/{folder_id} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Folder id | 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 the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.  
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. Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example `?field=metadata.enterprise_12345.contractTemplate`.  
If none match | 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.  
The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly shared with a user. Use the format `shared_link=[link]` or if a password is required then use `shared_link=[link]&shared_link_password=[password]`. This header can be used on the file or folder shared, as well as on any files or folders nested within the item.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 folder collaborations
`<box:get-folders-collaborations-by-folder-id>`
Retrieves a list of pending and active collaborations for a folder. This returns all the users that have access to the folder or have been invited to the folder. This operation makes an HTTP GET request to the /folders/{folder_id}/collaborations endpoint.
In Box Connector 5.2.2 and later, this operation no longer uses pagination since Box changed its underlying API endpoint, so the **offset** and **limit** fields are now ignored but are present only for backward compatibility.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Folder id | 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 the `folder_id` is `123`.  
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.  
The offset of the item at which to begin the response. In Box Connector 5.2.2 and later, this field is ignored but is present only for backward compatibility.  
The maximum number of items to return per page. In Box Connector 5.2.2 and later, this field is ignored but is present only for backward compatibility.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable
| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 shared link for folder
`<box:get-folders-get-shared-link-by-folder-id>`
Gets the information for a shared link on a folder. This operation makes an HTTP GET request to the /folders/{folder_id}#get_shared_link endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Folder id | 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 the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.  
Explicitly request the `shared_link` fields to be returned for this item.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 items in folder
`<box:get-folders-items-by-folder-id>`
Retrieves a page of items in a folder. These items can be files, folders, and web links. To request more information about the folder itself, like its size, use the [Get a folder](#get-folders-id) endpoint instead. This operation makes an HTTP GET request to the /folders/{folder_id}/items endpoint. The operation automatically paginates the results using offset pagination.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Folder id | 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 the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.  
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. Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example `?field=metadata.enterprise_12345.contractTemplate`.  
DO NOT USE - usemarker | Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By setting this value to true, the API will return a `marker` field that can be passed as a parameter to this endpoint to get the next page of the response.  
DO NOT USE - marker | 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`.  
The offset of the item at which to begin the response.  
The maximum number of items to return per page.  
Enumeration, one of:

| Defines the **second** attribute by which items are sorted. Items are always sorted by their `type` first, with folders listed before files, and files listed before web links. This parameter is not supported for marker-based pagination on the root folder (the folder with an ID of `0`).  
direction |  Enumeration, one of: | The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order.  
The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly shared with a user. Use the format `shared_link=[link]` or if a password is required then use `shared_link=[link]&shared_link_password=[password]`. This header can be used on the file or folder shared, as well as on any files or folders nested within the item.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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
| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 metadata instances on folder
`<box:get-folders-metadata-by-folder-id>`
Retrieves all metadata for a given folder. This can not be used on the root folder with ID `0`. This operation makes an HTTP GET request to the /folders/{folder_id}/metadata endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Folder id | 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 the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 metadata instance on folder
`<box:get-folders-metadata-by-folder-id-scope-template-key>`
Retrieves the instance of a metadata template that has been applied to a folder. This cannot be used on the root folder with an ID of `0`. This operation makes an HTTP GET request to the /folders/{folder_id}/metadata/{scope}/{template_key} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Folder id | 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 the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.  
Enumeration, one of:
  * GLOBAL
  * ENTERPRISE

| The scope of the metadata template  
Template key | The name of the metadata template  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 classification on folder
`<box:get-folders-metadata-enterprise-security-classification6vmvochw-uwo-by-folder-id>`
Retrieves the classification metadata instance that has been applied to 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 GET request to the /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Folder id | 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 the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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
| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 trashed folder
`<box:get-folders-trash-by-folder-id>`
Retrieves a folder that has been moved to the trash. If only the folder itself has been moved to the trash, it can be retrieved with this API call. If instead, one of its parent folders was moved to the trash, that folder can only be inspected using the [`GET /folders/:id/trash`](e://get_folders_id_trash) API. To list all items that have been moved to the trash, use the [`GET /folders/trash/items`](e://get-folders-trash-items/) API. This operation makes an HTTP GET request to the /folders/{folder_id}/trash endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Folder id | 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 the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.  
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.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 trashed items
`<box:get-folders-trash-items>`
Retrieves the files and folders that have been moved to the trash. Any attribute in the full files or folders objects can be passed in with the `fields` parameter to retrieve those specific attributes that are not returned by default. This endpoint defaults to use offset-based pagination, and also supports marker-based pagination using the `marker` parameter. This operation makes an HTTP GET request to the /folders/trash/items endpoint. The operation automatically paginates the results using offset pagination.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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.  
The maximum number of items to return per page.  
The offset of the item at which to begin the response.  
DO NOT USE - usemarker | Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By setting this value to true, the API will return a `marker` field that can be passed as a parameter to this endpoint to get the next page of the response.  
DO NOT USE - marker | 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`.  
direction |  Enumeration, one of: | The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order.  
Enumeration, one of:

| Defines the **second** attribute by which items are sorted. Items are always sorted by their `type` first, with folders listed before files, and files listed before web links. This parameter is not supported when using marker-based pagination.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 watermark for folder
`<box:get-folders-watermark-by-folder-id>`
Retrieve the watermark for a folder. This operation makes an HTTP GET request to the /folders/{folder_id}/watermark endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Folder id | 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 the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
## Get watermark for folder
`<box:get-folders-watermark-by-folder-id>`
Retrieve the watermark for a folder. This operation makes an HTTP GET request to the /folders/{folder_id}/watermark endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Folder id | 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 the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 group membership
`<box:get-group-memberships-by-group-membership-id>`
Retrieves 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 GET request to the /group_memberships/{group_membership_id} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Group membership id | The ID of the group membership.  
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.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 groups for enterprise
`<box:get-groups>`
Retrieves all of the groups for a given enterprise. The user must have admin permissions to inspect enterprise’s groups. This operation makes an HTTP GET request to the /groups endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Filter term | Limits the results to only groups whose `name` starts with the search term.  
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.  
The maximum number of items to return per page.  
The offset of the item at which to begin the response.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 group
`<box:get-groups-by-group-id>`
Retrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API. This operation makes an HTTP GET request to the /groups/{group_id} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Group id | The ID of the group.  
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.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER
| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 collaborations for group
`<box:get-groups-collaborations-by-group-id>`
Retrieves all the collaborations for a group. The user must have admin permissions to inspect enterprise’s groups. Each collaboration object has details on which files or folders the group has access to and with what role. This operation makes an HTTP GET request to the /groups/{group_id}/collaborations endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Group id | The ID of the group.  
The maximum number of items to return per page.  
The offset of the item at which to begin the response.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 members of group
`<box:get-groups-memberships-by-group-id>`
Retrieves all the members for a group. Only members of this group or users with admin-level permissions will be able to use this API. This operation makes an HTTP GET request to the /groups/{group_id}/memberships endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Group id | The ID of the group.  
The maximum number of items to return per page.  
The offset of the item at which to begin the response.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 invite status
`<box:get-invites-by-invite-id>`
Returns the status of a user invite. This operation makes an HTTP GET request to the /invites/{invite_id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Invite id | The ID of an invite.  
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.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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
| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 legal hold policies
`<box:get-legal-hold-policies>`
Retrieves a list of legal hold policies that belong to an enterprise. This operation makes an HTTP GET request to the /legal_hold_policies endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Policy name | Limits results to policies for which the names start with this search term. This is a case-insensitive prefix.  
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.  
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`.  
The maximum number of items to return per page.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 legal hold policy
`<box:get-legal-hold-policies-by-legal-hold-policy-id>`
Retrieve a legal hold policy. This operation makes an HTTP GET request to the /legal_hold_policies/{legal_hold_policy_id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Legal hold policy id | The ID of the legal hold policy  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 legal hold policy assignments
`<box:get-legal-hold-policy-assignments>`
Retrieves a list of items a legal hold policy has been assigned to. This operation makes an HTTP GET request to the /legal_hold_policy_assignments endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Policy id | The ID of the legal hold policy  
Assign to type |  Enumeration, one of:
  * FILE_VERSION
  * FOLDER

| Filters the results by the type of item the policy was applied to.  
Assign to id | Filters the results by the ID of item the policy was applied to.  
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`.  
The maximum number of items to return per page.  
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.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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
| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 legal hold policy assignment
`<box:get-legal-hold-policy-assignments-by-legal-hold-policy-assignment-id>`
Retrieve a legal hold policy assignment. This operation makes an HTTP GET request to the /legal_hold_policy_assignments/{legal_hold_policy_assignment_id} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Legal hold policy assignment id | The ID of the legal hold policy assignment  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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 previous file versions for legal hold policy assignment
`<box:get-legal-hold-policy-assignments-file-versions-on-hold-by-legal-hold-policy-assignment-id>`
Get a list of previous file versions for a legal hold assignment. In some cases you may only need the latest file versions instead. In these cases, use the `GET /legal_hold_policy_assignments/:id/files_on_hold` API instead to return any current (latest) versions of a file for this legal hold policy assignment. Due to ongoing re-architecture efforts this API might not return all files held for this policy ID. Instead, this API will only return past file versions held in the newly developed architecture. The `GET /file_version_legal_holds` API can be used to fetch current and past versions of files held within the legacy architecture. 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. This operation makes an HTTP GET request to the /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/file_versions_on_hold endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Legal hold policy assignment id | The ID of the legal hold policy assignment  
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`.  
The maximum number of items to return per page.  
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.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 current file versions for legal hold policy assignment
`<box:get-legal-hold-policy-assignments-files-on-hold-by-legal-hold-policy-assignment-id>`
Gets a list of current file versions for a legal hold assignment. In some cases you may want to get previous file versions instead. In these cases, use the `GET /legal_hold_policy_assignments/:id/file_versions_on_hold` API instead to return any previous versions of a file for this legal hold policy assignment.
Due to ongoing rearchitecture efforts, this API might not return all file versions held for this policy ID. Instead, this API will return only the latest file version held in the newly developed architecture. The `GET /file_version_legal_holds` API can be used to fetch current and past versions of files held within the legacy architecture. 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.
This operation makes an HTTP GET request to the /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/files_on_hold endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Legal hold policy assignment id | The ID of the legal hold policy assignment  
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`.  
The maximum number of items to return per page.  
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.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 metadata cascade policies
`<box:get-metadata-cascade-policies>`
Retrieves a list of all the metadata cascade policies that are applied to a given folder. This can not be used on the root folder with ID `0`. This operation makes an HTTP GET request to the /metadata_cascade_policies endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Folder id | Specifies which folder to return policies for. This can not be used on the root folder with ID `0`.  
Owner enterprise id | The ID of the enterprise ID for which to find metadata cascade policies. If not specified, it defaults to the current enterprise.  
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`.  
The offset of the item at which to begin the response.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 metadata cascade policy
`<box:get-metadata-cascade-policies-by-metadata-cascade-policy-id>`
Retrieve a specific metadata cascade policy assigned to a folder. This operation makes an HTTP GET request to the /metadata_cascade_policies/{metadata_cascade_policy_id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Metadata cascade policy id | The ID of the metadata cascade policy.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**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


## Find metadata template by instance ID
`<box:get-metadata-templates>`
Finds a metadata template by searching for the ID of an instance of the template. This operation makes an HTTP GET request to the /metadata_templates endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Metadata instance id | The ID of an instance of the metadata template to find.  
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`.  
Output Mime Type | The MIME type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configures how Mule processes streams. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Response Timeout**.  
Streaming Type |  Enumeration, one of:
  * 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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
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 metadata template by ID
`<box:get-metadata-templates-by-template-id>`
Retrieves a metadata template by its ID. This operation makes an HTTP GET request to the /metadata_templates/{template_id} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Template id | The ID of the template  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream