Box Connector Reference 5.3 - Mule 4
Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. |
Anypoint Connector for Box (Box Connector) provides access to the Box Content API for secure content management and content experience features for use in your own app. The connector is RESTful and is organized around the main resources you’re familiar with from the Box web interface.
Configurations
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
String |
Name for this configuration. Connectors reference the configuration with this name. |
X |
|
Connection |
Connection types to provide to this configuration. |
X |
||
Response Timeout |
Number |
The timeout for request to the remote service. |
1 |
|
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
MINUTES |
|
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
AUTO |
|
Name |
String |
The identifier of this element used to reference it in other components |
X |
|
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate. |
Connection Types
JWT
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Default Headers |
Array of Default Header |
|||
Query Parameters |
Array of Default Query Param |
|||
Connection Timeout |
Number |
The timeout for establishing connections to the remote service |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
Time unit which qualifies the Connection Timeout. |
SECONDS |
|
Use Persistent Connections |
Boolean |
If false, each connection will be closed after the first request is completed. |
true |
|
Max Connections |
Number |
The maximum number of outbound connections that will be kept open at the same time |
-1 |
|
Connection Idle Timeout |
Number |
A timeout for how long a connection can remain idle before it is closed |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the connection Idle Timeout. |
SECONDS |
|
Proxy Config |
Reusable configuration element for outbound connections through a proxy |
|||
Stream Response |
Boolean |
Whether or not received responses should be streamed |
false |
|
Response Buffer Size |
Number |
The space in bytes for the buffer where the HTTP response will be stored. |
-1 |
|
Client ID |
String |
X |
||
Client Secret |
String |
X |
||
Public Key Id |
String |
ID of the Public Key configured in your Box instance to authenticate the application. |
X |
|
Entity Id |
String |
The type of the Entity ID: EnterpriseId or UserId |
X |
|
Box Sub Type |
Enumeration, one of:
|
The box sub type: enterprise or user |
X |
|
Algorithm |
Enumeration, one of:
|
The RSA encryption algorithm used to encrypt the private key. |
X |
|
Keystore |
String |
Path to keystore |
X |
|
Keystore Type |
String |
Keystore type: JKS, PKCS12, BCFKS, etc. |
X |
|
Store Password |
String |
Password of key store |
X |
|
Key Alias |
String |
Alias which identifies the key |
X |
|
Key Password |
String |
Key password |
X |
|
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy |
Oauth2security Connection Provider
Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Default Headers |
Array of Default Header |
|||
Query Parameters |
Array of Default Query Param |
|||
Connection Timeout |
Number |
The timeout for establishing connections to the remote service |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
Time unit which qualifies the Connection Timeout. |
SECONDS |
|
Use Persistent Connections |
Boolean |
If false, each connection is closed after the first request is completed. |
true |
|
Max Connections |
Number |
Maximum number of outbound connections to keep open concurrently. |
-1 |
|
Connection Idle Timeout |
Number |
A timeout for how long a connection can remain idle before it is closed. |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
Time unit which qualifies the connection Idle Timeout. |
SECONDS |
|
Proxy Config |
Reusable configuration element for outbound connections through a proxy. |
|||
Stream Response |
Boolean |
Whether or not to stream received responses. |
false |
|
Response Buffer Size |
Number |
The space in bytes for the buffer where the HTTP response is stored. |
-1 |
|
Protocol |
Enumeration, one of:
|
Protocol to use for communication. Valid values are HTTP and HTTPS. |
HTTP |
|
TLS Configuration |
||||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
|||
Consumer Key |
String |
The OAuth consumerKey, as registered with the service provider. |
X |
|
Consumer Secret |
String |
The OAuth consumerSecret, as registered with the service provider. |
X |
|
Authorization Url |
String |
Service provider’s authorization endpoint URL |
||
Access Token Url |
String |
The service provider’s accessToken endpoint URL |
||
Scopes |
String |
The OAuth scopes to request during the OAuth dance. If not provided, the values default to those in the annotation. |
|
|
Resource Owner Id |
String |
Resource owner ID each component should use if the resource owner ID is not otherwise referenced. |
||
Before |
String |
The name of a flow to execute immediately before starting the OAuth dance. |
||
After |
String |
The name of a flow to execute immediately after an access token is received. |
||
Listener Config |
String |
A reference to an |
X |
|
Callback Path |
String |
The path of the access token callback endpoint |
X |
|
Authorize Path |
String |
The path of the local http endpoint which triggers the OAuth dance |
X |
|
External Callback Url |
String |
If the callback endpoint is behind a proxy or should be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL it should use to access the callback |
||
Object Store |
String |
A reference to the object store to use to store each resource owner ID’s data. If not specified, Mule automatically provisions the default object store. |
Associated Operations
Add domain to list of allowed collaboration domains
<box:create-collaboration-whitelist-entries>
Creates a new entry in the list of domains allowed to collaborate. This operation makes an HTTP POST request to the /collaboration_whitelist_entries endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create user exemption from collaboration domain restrictions
<box:create-collaboration-whitelist-exempt-targets>
Exempts a user from the restrictions set out by the allowed list of domains for collaborations. This operation makes an HTTP POST request to the /collaboration_whitelist_exempt_targets endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create collaboration
<box:create-collaborations>
Adds a collaboration for a single user or a single group to a file or folder. Collaborations can be created using email address, user IDs, or a group IDs. If a collaboration is being created with a group, access to this endpoint is dependent on the group’s ability to be invited. This operation makes an HTTP POST request to the /collaborations endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
notify |
Boolean |
Determines if users should receive email notification for the action performed. |
false |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create comment
<box:create-comments>
Adds a comment by the user to a specific file, or as a reply to an other comment. This operation makes an HTTP POST request to the /comments endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Copy file request
<box:create-file-requests-copy-by-file-request-id>
Copies an existing file request that is present on one folder, and applies it to another folder. This operation makes an HTTP POST request to the /file_requests/{file_request_id}/copy endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File request id |
String |
The unique identifier that represents a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Body |
String |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Restore file
<box:create-files-by-file-id>
Restores a file that was moved to the trash. An optional new parent ID can be provided to restore the file to in case the original folder has been deleted. This operation makes an HTTP POST request to the /files/{file_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Upload file
<box:create-files-content>
Uploads a small file to Box. For file sizes over 50MB, use the Chunk Upload APIs.
In the Request body, the attributes
part of the body must come before the file
part. Requests that do not follow this format when uploading the file will receive an HTTP 400
error with a metadata_after_file_contents
error code.
This operation makes an HTTP POST request to the /files/content endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Content md5 |
String |
An optional header containing the SHA1 hash of the file to ensure that the file was not corrupted in transit. |
||
Attributes - Body |
Any |
The content of the 'attributes' part. |
#[payload] |
|
File - Body |
String |
The content of the 'file' part. |
X |
|
file Filename |
String |
The filename of the 'file' part (just the name, do not include path). |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Upload file version
<box:create-files-content-by-file-id>
Updates a file’s content. For file sizes over 50MB, use the Chunk Upload APIs.
For the Request body order, the attributes
part of the body must come before the file
part. Requests that do not follow this format when uploading the file will receive an HTTP 400
error with a metadata_after_file_contents
error code.
This operation makes an HTTP POST request to the /files/{file_id}/content endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
If match |
String |
Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed |
||
Content md5 |
String |
An optional header containing the SHA1 hash of the file to ensure that the file was not corrupted in transit. |
||
Attributes - Body |
Any |
The content of the 'attributes' part. |
#[payload] |
|
File - Body |
String |
The content of the 'file' part. |
X |
|
file Filename |
String |
The filename of the 'file' part. Do not include the path; use only the file name. |
X |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Copy file
<box:create-files-copy-by-file-id>
Creates a copy of a file. This operation makes an HTTP POST request to the /files/{file_id}/copy endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create metadata instance on file
<box:create-files-metadata-by-file-id-scope-template-key>
Applies an instance of a metadata template to a file. In most cases only values that are present in the metadata template will be accepted, with the exception of the global.properties
template, which accepts any key-value pair.
This operation makes an HTTP POST request to the /files/{file_id}/metadata/{scope}/{template_key} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
scope |
Enumeration, one of:
|
The scope of the metadata template |
X |
|
Template key |
String |
The name of the metadata template |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add classification to file
<box:create-files-metadata-enterprise-security-classification6vmvochw-uwo-by-file-id>
Adds a classification to a file by specifying the label of the classification to add. This API can also be called by including the enterprise ID in the URL explicitly, for example /files/:id//enterprise_12345/securityClassification-6VMVochwUWo
.
This operation makes an HTTP POST request to the /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Box Skill cards on file
<box:create-files-metadata-global-box-skills-cards-by-file-id>
Applies one or more Box Skills metadata cards to a file. This operation makes an HTTP POST request to the /files/{file_id}/metadata/global/boxSkillsCards endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create upload session
<box:create-files-upload-sessions>
Creates an upload session for a new file. This operation makes an HTTP POST request to the /files/upload_sessions endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create upload session for existing file
<box:create-files-upload-sessions-by-file-id>
Creates an upload session for an existing file. This operation makes an HTTP POST request to the /files/{file_id}/upload_sessions endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for requests to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Commit upload session
<box:create-files-upload-sessions-commit-by-upload-session-id>
Closes an upload session and create a file from the uploaded chunks. This operation makes an HTTP POST request to the /files/upload_sessions/{upload_session_id}/commit endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Upload session id |
String |
The ID of the upload session. |
X |
|
digest |
String |
The [RFC3230][1] message digest of the whole file. Only SHA1 is supported. The SHA1 digest must be Base64 encoded. The format of this header is as |
X |
|
If match |
String |
Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed |
||
If none match |
String |
Ensures an item is only returned if it has changed. Pass in the item’s last observed |
||
Body |
Any |
Content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for requests to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Revert file version
<box:create-files-versions-current-by-file-id>
Reverts to a previous version of a file. If previous versions exist, this method can be used to promote one of the older versions to the top of the version history. This creates a new copy of the old version of the file and puts it at the top of the versions history. The file will have the exact same contents as the older version, with the the same hash digest, etag
, and name as the original. Other properties, such as comments do not get updated to their former values.
This operation makes an HTTP POST request to the /files/{file_id}/versions/current endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create folder lock on folder
<box:create-folder-locks>
Creates a folder lock on a folder, preventing it from being moved and/or deleted. This operation makes an HTTP POST request to the /folder_locks endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
Content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create folder
<box:create-folders>
Creates a new empty folder within the specified parent folder. This operation makes an HTTP POST request to the /folders endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Restore folder
<box:create-folders-by-folder-id>
Restores a folder that has been moved to the trash. An optional new parent ID can be provided to restore the folder to in case the original folder has been deleted.
Folder locking
During this operation, part of the file tree will be locked, mainly the source folder and all of its descendants, as well as the destination folder. For the duration of the operation, no other move, copy, delete, or restore operation can performed on any of the locked folders.
This operation makes an HTTP POST request to the /folders/{folder_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represents a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Copy folder
<box:create-folders-copy-by-folder-id>
Creates a copy of a folder within a destination folder. The original folder will not be changed. This operation makes an HTTP POST request to the /folders/{folder_id}/copy endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier of the folder to copy. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create metadata instance on folder
<box:create-folders-metadata-by-folder-id-scope-template-key>
Applies an instance of a metadata template to a folder. In most cases, only values that are present in the metadata template will be accepted, with the exception of the global.properties
template, which accepts any key-value pair.
To display the metadata template in the Box web app, the enterprise must be configured to enable Cascading Folder Level Metadata for the user in the admin console.
This operation makes an HTTP POST request to the /folders/{folder_id}/metadata/{scope}/{template_key} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
scope |
Enumeration, one of:
|
The scope of the metadata template |
X |
|
Template key |
String |
The name of the metadata template |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add classification to folder
<box:create-folders-metadata-enterprise-security-classification6vmvochwUwo-by-folder-id>
Adds a classification to a folder by specifying the label of the classification to add. This API can also be called by including the enterprise ID in the URL explicitly, for example /folders/:id//enterprise_12345/securityClassification-6VMVochwUWo
.
This operation makes an HTTP POST request to the /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add user to group
<box:create-group-memberships>
Creates a group membership. Only users with admin-level permissions will be able to use this API. This operation makes an HTTP POST request to the /group_memberships endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create group
<box:create-groups>
Creates a new group of users in an enterprise. Only users with admin permissions can create new groups. This operation makes an HTTP POST request to the /groups endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create user invite
<box:create-invites>
Invites an existing external user to join an enterprise. The existing user can not be part of another enterprise and must already have a Box account. Once invited, the user will receive an email and are prompted to accept the invitation within the Box web application. This method requires the "Manage An Enterprise" scope enabled for the application, which can be enabled within the developer console. This operation makes an HTTP POST request to the /invites endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create legal hold policy
<box:create-legal-hold-policies>
Create a new legal hold policy. This operation makes an HTTP POST request to the /legal_hold_policies endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Assign legal hold policy
<box:create-legal-hold-policy-assignments>
Assigns a legal hold to a file, file version, folder, or user. This operation makes an HTTP POST request to the /legal_hold_policy_assignments endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create metadata cascade policy
<box:create-metadata-cascade-policies>
Creates a new metadata cascade policy that applies a given metadata template to a given folder and automatically cascades it down to any files within that folder. In order for the policy to be applied a metadata instance must first be applied to the folder the policy is to be applied to. This operation makes an HTTP POST request to the /metadata_cascade_policies endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Force-apply metadata cascade policy to folder
<box:create-metadata-cascade-policies-apply-by-metadata-cascade-policy-id>
Forces the metadata on a folder with a metadata cascade policy to be applied to all of its children. This can be used after creating a new cascade policy to enforce the metadata to be cascaded down to all existing files within that folder.
This operation makes an HTTP POST request to the /metadata_cascade_policies/{metadata_cascade_policy_id}/apply endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Metadata cascade policy id |
String |
The ID of the cascade policy to force-apply. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Query files and folders by metadata
<box:create-metadata-queries-execute-read>
Create a search using SQL-like syntax to return items that match specific metadata. By default, this endpoint returns only the most basic info about the items for which the query matches. To get additional fields for each item, including any of the metadata, use the fields
attribute in the query. This operation makes an HTTP POST request to the /metadata_queries/execute_read endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create metadata template
<box:create-metadata-templates-schema>
Creates a new metadata template that can be applied to files and folders. This operation makes an HTTP POST request to the /metadata_templates/schema endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add initial classifications
<box:create-metadata-templates-schemaclassifications>
When an enterprise does not yet have any classifications, this API call initializes the classification template with an initial set of classifications. If an enterprise already has a classification, the template will already exist and instead an API call should be made to add additional classifications.
This operation makes an HTTP POST request to the /metadata_templates/schema#classifications endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create retention policy
<box:create-retention-policies>
Creates a retention policy. This operation makes an HTTP POST request to the /retention_policies endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Assign retention policy
<box:create-retention-policy-assignments>
Assigns a retention policy to an item. This operation makes an HTTP POST request to the /retention_policy_assignments endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Assign storage policy
<box:create-storage-policy-assignments>
Creates a storage policy assignment for an enterprise or user. This operation makes an HTTP POST request to the /storage_policy_assignments endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Assign task
<box:create-task-assignments>
Assigns a task to a user. A task can be assigned to more than one user by creating multiple assignments. This operation makes an HTTP POST request to the /task_assignments endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create task
<box:create-tasks>
Creates a single task on a file. This task is not assigned to any user and will need to be assigned separately. This operation makes an HTTP POST request to the /tasks endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create terms of service status for new user
<box:create-terms-of-service-user-statuses>
Sets the status for a terms of service for a user. This operation makes an HTTP POST request to the /terms_of_service_user_statuses endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create terms of service
<box:create-terms-of-services>
Creates a terms of service for a given enterprise and type of user. This operation makes an HTTP POST request to the /terms_of_services endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create user
<box:create-users>
Creates a new managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions. This operation makes an HTTP POST request to the /users endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create email alias
<box:create-users-email-aliases-by-user-id>
Adds a new email alias to a user account. This operation makes an HTTP POST request to the /users/{user_id}/email_aliases endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
User id |
String |
The ID of the user. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create web link
<box:create-web-links>
Creates a web link object within a folder. This operation makes an HTTP POST request to the /web_links endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Restore web link
<box:create-web-links-by-web-link-id>
Restores a web link that has been moved to the trash. An optional new parent ID can be provided to restore the web link in case the original folder has been deleted.
This operation makes an HTTP POST request to the /web_links/{web_link_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Web link id |
String |
The ID of the web link. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create webhook
<box:create-webhooks>
Creates a webhook. This operation makes an HTTP POST request to the /webhooks endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create zip download
<box:create-zip-downloads>
Creates a request to download multiple files and folders as a single zip
archive file. This API does not return the archive but instead performs all the checks to ensure that the user has access to all the items, and then returns a download_url
and a status_url
that can be used to download the archive. The limit for an archive is either 32GB or 10,000 files, whichever limitation is met first.
This operation makes an HTTP POST request to the /zip_downloads endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove domain from list of allowed collaboration domains
<box:delete-collaboration-whitelist-entries-by-collaboration-whitelist-entry-id>
Removes a domain from the list of domains that have been deemed safe to create collaborations for within the current enterprise. This operation makes an HTTP DELETE request to the /collaboration_whitelist_entries/{collaboration_whitelist_entry_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Collaboration whitelist entry id |
String |
The ID of the entry in the list. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove user from list of users exempt from domain restrictions
<box:delete-collaboration-whitelist-exempt-targets-by-collaboration-whitelist-exempt-target-id>
Removes a user’s exemption from the restrictions set out by the allowed list of domains for collaborations. This operation makes an HTTP DELETE request to the /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Collaboration whitelist exempt target id |
String |
The ID of the exemption to the list. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove collaboration
<box:delete-collaborations-by-collaboration-id>
Deletes a single collaboration. This operation makes an HTTP DELETE request to the /collaborations/{collaboration_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Collaboration id |
String |
The ID of the collaboration |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove comment
<box:delete-comments-by-comment-id>
Permanently deletes a comment. This operation makes an HTTP DELETE request to the /comments/{comment_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Comment id |
String |
The ID of the comment. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove device pin
<box:delete-device-pinners-by-device-pinner-id>
Deletes an individual device pin. This operation makes an HTTP DELETE request to the /device_pinners/{device_pinner_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Device pinner id |
String |
The ID of the device pin |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete file request
<box:delete-file-requests-by-file-request-id>
Deletes a file request permanently. This operation makes an HTTP DELETE request to the /file_requests/{file_request_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File request id |
String |
The unique identifier that represents a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete file
<box:delete-files-by-file-id>
Deletes a file, either permanently or by moving it to the trash. The enterprise settings determine whether the item will be permanently deleted from Box or moved to the trash.
This operation makes an HTTP DELETE request to the /files/{file_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
If match |
String |
Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove metadata instance from file
<box:delete-files-metadata-by-file-id-scope-template-key>
Deletes a piece of file metadata. This operation makes an HTTP DELETE request to the /files/{file_id}/metadata/{scope}/{template_key} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
scope |
Enumeration, one of:
|
The scope of the metadata template |
X |
|
Template key |
String |
The name of the metadata template |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove classification from file
<box:delete-files-metadata-enterprise-security-classification-by-file-id>
Removes any classifications from a file. This API can also be called by including the enterprise ID in the URL explicitly, for example /files/:id//enterprise_12345/securityClassification-6VMVochwUWo
.
This operation makes an HTTP DELETE request to the /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove Box Skill cards from file
<box:delete-files-metadata-global-box-skills-cards-by-file-id>
Removes any Box Skills cards metadata from a file. This operation makes an HTTP DELETE request to the /files/{file_id}/metadata/global/boxSkillsCards endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Permanently remove file
<box:delete-files-trash-by-file-id>
Permanently deletes a file that is in the trash. This action cannot be undone. This operation makes an HTTP DELETE request to the /files/{file_id}/trash endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Remove upload session
<box:delete-files-upload-sessions-by-upload-session-id>
Abort an upload session and discard all data uploaded. This cannot be reversed. This operation makes an HTTP DELETE request to the /files/upload_sessions/{upload_session_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Upload session id |
String |
The ID of the upload session. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove file version
<box:delete-files-versions-by-file-id-file-version-id>
Moves a file version to the trash. Versions are only tracked for Box users with premium accounts. This operation makes an HTTP DELETE request to the /files/{file_id}/versions/{file_version_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
File version id |
String |
The ID of the file version |
X |
|
If match |
String |
Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove watermark from file
<box:delete-files-watermark-by-file-id>
Removes the watermark from a file. This operation makes an HTTP DELETE request to the /files/{file_id}/watermark endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete folder lock
<box:delete-folder-locks-by-folder-lock-id>
Deletes a folder lock on a given folder. This operation makes an HTTP DELETE request to the /folder_locks/{folder_lock_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Folder lock id |
String |
The ID of the folder lock. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Delete folder
<box:delete-folders-by-folder-id>
Deletes a folder, either permanently or by moving it to the trash. This operation makes an HTTP DELETE request to the /folders/{folder_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
recursive |
Boolean |
Delete a folder that is not empty by recursively deleting the folder and all of its content. |
false |
|
If match |
String |
Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove metadata instance from folder
<box:delete-folders-metadata-by-folder-id-scope-template-key>
Deletes a piece of folder metadata. This operation makes an HTTP DELETE request to the /folders/{folder_id}/metadata/{scope}/{template_key} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
scope |
Enumeration, one of:
|
The scope of the metadata template |
X |
|
Template key |
String |
The name of the metadata template |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove classification from folder
<box:delete-folders-metadata-enterprise-security-classification6vmvochw-uwo-by-folder-id>
Removes any classifications from a folder. This API can also be called by including the enterprise ID in the URL explicitly, for example /folders/:id//enterprise_12345/securityClassification-6VMVochwUWo
.
This operation makes an HTTP DELETE request to the /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Permanently remove folder
<box:delete-folders-trash-by-folder-id>
Permanently deletes a folder that is in the trash. This action cannot be undone. This operation makes an HTTP DELETE request to the /folders/{folder_id}/trash endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Remove watermark from folder
<box:delete-folders-watermark-by-folder-id>
Removes the watermark from a folder. This operation makes an HTTP DELETE request to the /folders/{folder_id}/watermark endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove user from group
<box:delete-group-memberships-by-group-membership-id>
Deletes a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API. This operation makes an HTTP DELETE request to the /group_memberships/{group_membership_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Group membership id |
String |
The ID of the group membership. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove group
<box:delete-groups-by-group-id>
Permanently deletes a group. Only users with admin-level permissions will be able to use this API. This operation makes an HTTP DELETE request to the /groups/{group_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Group id |
String |
The ID of the group. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove legal hold policy
<box:delete-legal-hold-policies-by-legal-hold-policy-id>
Delete an existing legal hold policy. This is an asynchronous process. The policy will not be fully deleted yet when the response returns. This operation makes an HTTP DELETE request to the /legal_hold_policies/{legal_hold_policy_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Legal hold policy id |
String |
The ID of the legal hold policy |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Unassign legal hold policy
<box:delete-legal-hold-policy-assignments-by-legal-hold-policy-assignment-id>
Removes a legal hold from an item. This is an asynchronous process. The policy will not be fully removed yet when the response returns. This operation makes an HTTP DELETE request to the /legal_hold_policy_assignments/{legal_hold_policy_assignment_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Legal hold policy assignment id |
String |
The ID of the legal hold policy assignment |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove metadata cascade policy
<box:delete-metadata-cascade-policies-by-metadata-cascade-policy-id>
Deletes a metadata cascade policy. This operation makes an HTTP DELETE request to the /metadata_cascade_policies/{metadata_cascade_policy_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Metadata cascade policy id |
String |
The ID of the metadata cascade policy. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete all classifications
<box:delete-metadata-templates-enterprise-security-classification6vmvochw-uwo-schema>
Deletes all classifications by deleting the classification metadata template. This operation makes an HTTP DELETE request to the /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove metadata template
<box:delete-metadata-templates-schema-by-scope-template-key>
Deletes a metadata template and its instances. This deletion is permanent and can not be reversed. This operation makes an HTTP DELETE request to the /metadata_templates/{scope}/{template_key}/schema endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
scope |
Enumeration, one of:
|
The scope of the metadata template |
X |
|
Template key |
String |
The name of the metadata template |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Unassign storage policy
<box:delete-storage-policy-assignments-by-storage-policy-assignment-id>
Deletes a storage policy assignment. Deleting a storage policy assignment on a user will have the user inherit the enterprise’s default storage policy. There is a rate limit for calling this endpoint of only twice per user in a 24 hour time frame. This operation makes an HTTP DELETE request to the /storage_policy_assignments/{storage_policy_assignment_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Storage policy assignment id |
String |
The ID of the storage policy assignment. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Unassign task
<box:delete-task-assignments-by-task-assignment-id>
Deletes a specific task assignment. This operation makes an HTTP DELETE request to the /task_assignments/{task_assignment_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Task assignment id |
String |
The ID of the task assignment. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove task
<box:delete-tasks-by-task-id>
Removes a task from a file. This operation makes an HTTP DELETE request to the /tasks/{task_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Task id |
String |
The ID of the task. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete user
<box:delete-users-by-user-id>
Deletes a user. By default, this operation will fail if the user still owns any content. Move the user’s owned content before proceeding, or use the force
field to delete the user and their files. This operation makes an HTTP DELETE request to the /users/{user_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
User id |
String |
The ID of the user. |
X |
|
notify |
Boolean |
Whether the user will receive email notification of the deletion |
false |
|
force |
Boolean |
Whether the user should be deleted even if this user still own files |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove email alias
<box:delete-users-email-aliases-by-user-id-email-alias-id>
Removes an email alias from a user. This operation makes an HTTP DELETE request to the /users/{user_id}/email_aliases/{email_alias_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
User id |
String |
The ID of the user. |
X |
|
Email alias id |
String |
The ID of the email alias. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove web link
<box:delete-web-links-by-web-link-id>
Deletes a web link. This operation makes an HTTP DELETE request to the /web_links/{web_link_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Web link id |
String |
The ID of the web link. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Permanently remove web link
<box:delete-web-links-trash-by-web-link-id>
Permanently deletes a web link that is in the trash. This action cannot be undone. This operation makes an HTTP DELETE request to the /web_links/{web_link_id}/trash endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Web link id |
String |
The ID of the web link. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove webhook
<box:delete-webhooks-by-webhook-id>
Deletes a webhook. This operation makes an HTTP DELETE request to the /webhooks/{webhook_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Webhook id |
String |
The ID of the webhook. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List allowed collaboration domains
<box:get-collaboration-whitelist-entries>
Returns the list of domains that are deemed safe to create collaborations for within the current enterprise. This operation makes an HTTP GET request to the /collaboration_whitelist_entries endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
limit |
Number |
The maximum number of items to return per page. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get allowed collaboration domain
<box:get-collaboration-whitelist-entries-by-collaboration-whitelist-entry-id>
Returns a domain that has been deemed safe to create collaborations for within the current enterprise. This operation makes an HTTP GET request to the /collaboration_whitelist_entries/{collaboration_whitelist_entry_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Collaboration whitelist entry id |
String |
The ID of the entry in the list. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List users exempt from collaboration domain restrictions
<box:get-collaboration-whitelist-exempt-targets>
Returns a list of users who are exempt from the collaboration domain restrictions. This operation makes an HTTP GET request to the /collaboration_whitelist_exempt_targets endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
limit |
Number |
The maximum number of items to return per page. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get user exempt from collaboration domain restrictions
<box:get-collaboration-whitelist-exempt-targets-by-collaboration-whitelist-exempt-target-id>
Returns a user who is exempt from the collaboration domain restrictions.
This operation makes an HTTP GET request to the /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Collaboration whitelist exempt target id |
String |
The ID of the exemption to the list. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
List pending collaborations
<box:get-collaborations>
Retrieves a list of all pending collaboration invites for this user. This operation makes an HTTP GET request to the /collaborations endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
status |
Enumeration, one of:
|
The status of the collaborations to retrieve |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
offset |
Number |
The offset of the item at which to begin the response. |
0 |
|
limit |
Number |
The maximum number of items to return per page. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get collaboration
<box:get-collaborations-by-collaboration-id>
Retrieves a single collaboration. This operation makes an HTTP GET request to the /collaborations/{collaboration_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Collaboration id |
String |
The ID of the collaboration |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List all collections
<box:get-collections>
Retrieves a list of all collections for a given user. Currently, only the favorites
collection is supported. This operation makes an HTTP GET request to the /collections endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
offset |
Number |
The offset of the item at which to begin the response. |
0 |
|
limit |
Number |
The maximum number of items to return per page. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List collection items
<box:get-collections-items-by-collection-id>
Retrieves the files and folders contained within this collection. This operation makes an HTTP GET request to the /collections/{collection_id}/items endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Collection id |
String |
The ID of the collection. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, in addition to the fields requested. |
||
offset |
Number |
The offset of the item at which to begin the response. |
0 |
|
limit |
Number |
The maximum number of items to return per page. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get comment
<box:get-comments-by-comment-id>
Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment. This operation makes an HTTP GET request to the /comments/{comment_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Comment id |
String |
The ID of the comment. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get device pin
<box:get-device-pinners-by-device-pinner-id>
Retrieves information about an individual device pin. This operation makes an HTTP GET request to the /device_pinners/{device_pinner_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
X |
|
Device pinner id |
String |
ID of the device pin |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List enterprise device pins
<box:get-enterprises-device-pinners-by-enterprise-id>
Retrieves a list of all the device pins within an enterprise. The user must have admin privileges, and the application needs the manage enterprise
scope to make this call. This operation makes an HTTP GET request to the /enterprises/{enterprise_id}/device_pinners endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Enterprise id |
String |
The ID of the enterprise |
X |
|
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
limit |
Number |
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 ( |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List user and enterprise events
<box:get-events>
Returns up to a year of past events for a given user or for the entire enterprise. By default, this returns events for the authenticated user. To retrieve events for the entire enterprise, set the stream_type
to admin_logs
. The user making the API call must have admin privileges, and the application must have the permission to access the event feed to get the enterprise event feed. This operation makes an HTTP GET request to the /events endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Stream type |
Enumeration, one of:
|
Defines the type of events that are returned * |
ALL |
|
Stream position |
String |
The location in the event stream to start receiving events from. * |
||
limit |
Number |
Limits the number of events returned |
100 |
|
Event type |
Array of Enumeration, one of:
|
A comma-separated list of events to filter by. This can only be used when requesting the events with a |
||
Created after |
String |
The lower bound date and time to return events for. This can only be used when requesting the events with a |
||
Created before |
String |
The upper bound date and time to return events for. This can only be used when requesting the events with a |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get file request
<box:get-file-requests-by-file-request-id>
Retrieves the information about a file request. This operation makes an HTTP GET request to the /file_requests/{file_request_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File request id |
String |
The unique identifier that represents a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List file version legal holds
<box:get-file-version-legal-holds>
Gets a list of file versions on legal hold for a legal hold assignment. Due to ongoing rearchitecture efforts, this API might not return all file versions for this policy ID. Instead, this API will only return file versions held in the legacy architecture.
Two new endpoints are available to request any file versions held in the new architecture. For file versions held in the new architecture, the GET /legal_hold_policy_assignments/:id/file_versions_on_hold
API can be used to return all past file versions available for this policy assignment, and the GET /legal_hold_policy_assignments/:id/files_on_hold
API can be used to return any current (latest) versions of a file under legal hold. The GET /legal_hold_policy_assignments?policy_id={id}
API can be used to find a list of policy assignments for a given policy ID. After the rearchitecture is completed, this API will be deprecated.
This operation makes an HTTP GET request to the /file_version_legal_holds endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Policy id |
String |
The ID of the legal hold policy to get the file version legal holds for. |
X |
|
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
limit |
Number |
The maximum number of items to return per page. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get file version legal hold
<box:get-file-version-legal-holds-by-file-version-legal-hold-id>
Retrieves information about the legal hold policies assigned to a file version. This operation makes an HTTP GET request to the /file_version_legal_holds/{file_version_legal_hold_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File version legal hold id |
String |
The ID of the file version legal hold |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
File id |
String |
Filters results by files with this ID. |
||
File version id |
String |
Filters results by file versions with this ID. |
||
Policy id |
String |
Filters results by the retention policy with this ID. |
||
Disposition action |
Enumeration, one of:
|
Filters results by the retention policy with this disposition action. |
||
Disposition before |
String |
Filters results by files that will have their disposition come into effect before this date. |
||
Disposition after |
String |
Filters results by files that will have their disposition come into effect after this date. |
||
limit |
Number |
The maximum number of items to return per page. |
||
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
File version retention id |
String |
The ID of the file version retention |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. Additionally this field can be used to query any metadata applied to the file by specifying the |
||
If none match |
String |
Ensures an item is returned only if it has changed. Pass in the item’s last observed |
||
boxapi |
String |
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 |
||
X rep hints |
String |
A header required to request specific |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
limit |
Number |
The maximum number of items to return per page. |
||
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
limit |
Number |
The maximum number of items to return per page. |
||
offset |
Number |
The offset of the item at which to begin the response. |
0 |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
version |
String |
The file version to download |
||
Access token |
String |
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. |
||
range |
String |
The byte range of the content to download. The format |
||
boxapi |
String |
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 |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
String |
Explicitly request the |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
scope |
Enumeration, one of:
|
The scope of the metadata template |
X |
|
Template key |
String |
The name of the metadata template |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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. Thumbnails can be generated for the image and video file formats listed on the Box community site.
This operation makes an HTTP GET request to the /files/{file_id}/thumbnail.{extension} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
extension |
Enumeration, one of:
|
The file format for the thumbnail |
X |
|
Min height |
Number |
The minimum height of the thumbnail |
||
Min width |
Number |
The minimum width of the thumbnail |
||
Max height |
Number |
The maximum height of the thumbnail |
||
Max width |
Number |
The maximum width of the thumbnail |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Upload session id |
String |
The ID of the upload session. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Upload session id |
String |
The ID of the upload session. |
X |
|
offset |
Number |
The offset of the item at which to begin the response. |
0 |
|
limit |
Number |
The maximum number of items to return per page. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
limit |
Number |
The maximum number of items to return per page. |
||
offset |
Number |
The offset of the item at which to begin the response. |
0 |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
File version id |
String |
The ID of the file version |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. Additionally this field can be used to query any metadata applied to the file by specifying the |
||
If none match |
String |
Ensures an item is only returned if it has changed. Pass in the item’s last observed |
||
boxapi |
String |
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 |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
offset |
Number |
The offset of the item at which to begin the response. In Box Connector 5.2.2 and later, this field is ignored but is present only for backward compatibility. |
0 |
|
limit |
Number |
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 |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
String |
Explicitly request the |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. Additionally this field can be used to query any metadata applied to the file by specifying the |
||
DO NOT USE - usemarker |
Boolean |
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 |
false |
|
DO NOT USE - marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
offset |
Number |
The offset of the item at which to begin the response. |
0 |
|
limit |
Number |
The maximum number of items to return per page. |
||
sort |
Enumeration, one of:
|
Defines the second attribute by which items are sorted. Items are always sorted by their |
||
direction |
Enumeration, one of:
|
The direction to sort results in. This can be either in alphabetical ascending ( |
||
boxapi |
String |
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 |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
scope |
Enumeration, one of:
|
The scope of the metadata template |
X |
|
Template key |
String |
The name of the metadata template |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
limit |
Number |
The maximum number of items to return per page. |
||
offset |
Number |
The offset of the item at which to begin the response. |
0 |
|
DO NOT USE - usemarker |
Boolean |
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 |
false |
|
DO NOT USE - marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
direction |
Enumeration, one of:
|
The direction to sort results in. This can be either in alphabetical ascending ( |
||
sort |
Enumeration, one of:
|
Defines the second attribute by which items are sorted. Items are always sorted by their |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Group membership id |
String |
The ID of the group membership. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Filter term |
String |
Limits the results to only groups whose |
||
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
limit |
Number |
The maximum number of items to return per page. |
||
offset |
Number |
The offset of the item at which to begin the response. |
0 |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Group id |
String |
The ID of the group. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Group id |
String |
The ID of the group. |
X |
|
limit |
Number |
The maximum number of items to return per page. |
||
offset |
Number |
The offset of the item at which to begin the response. |
0 |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Group id |
String |
The ID of the group. |
X |
|
limit |
Number |
The maximum number of items to return per page. |
||
offset |
Number |
The offset of the item at which to begin the response. |
0 |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Invite id |
String |
The ID of an invite. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Policy name |
String |
Limits results to policies for which the names start with this search term. This is a case-insensitive prefix. |
||
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
limit |
Number |
The maximum number of items to return per page. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Legal hold policy id |
String |
The ID of the legal hold policy |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Policy id |
String |
The ID of the legal hold policy |
X |
|
Assign to type |
Enumeration, one of:
|
Filters the results by the type of item the policy was applied to. |
||
Assign to id |
String |
Filters the results by the ID of item the policy was applied to. |
||
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
limit |
Number |
The maximum number of items to return per page. |
||
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Legal hold policy assignment id |
String |
The ID of the legal hold policy assignment |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Legal hold policy assignment id |
String |
The ID of the legal hold policy assignment |
X |
|
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
limit |
Number |
The maximum number of items to return per page. |
||
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Legal hold policy assignment id |
String |
The ID of the legal hold policy assignment |
X |
|
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
limit |
Number |
The maximum number of items to return per page. |
||
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
Specifies which folder to return policies for. This can not be used on the root folder with ID |
X |
|
Owner enterprise id |
String |
The ID of the enterprise ID for which to find metadata cascade policies. If not specified, it defaults to the current enterprise. |
||
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
offset |
Number |
The offset of the item at which to begin the response. |
0 |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Metadata cascade policy id |
String |
The ID of the metadata cascade policy. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Metadata instance id |
String |
The ID of an instance of the metadata template to find. |
X |
|
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
X |
|
Template id |
String |
The ID of the template |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List all metadata templates for enterprise
<box:get-metadata-templates-enterprise>
Used to retrieve all metadata templates created to be used specifically within the user’s enterprise This operation makes an HTTP GET request to the /metadata_templates/enterprise endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
limit |
Number |
The maximum number of items to return per page. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List all classifications
<box:get-metadata-templates-enterprise-security-classification6vmvochw-uwo-schema>
Retrieves the classification metadata template and lists all the classifications available to this enterprise. This API can also be called by including the enterprise ID in the URL explicitly, for example /metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema
. This operation makes an HTTP GET request to the /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List all global metadata templates
<box:get-metadata-templates-global>
Used to retrieve all generic, global metadata templates available to all enterprises using Box. This operation makes an HTTP GET request to the /metadata_templates/global endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
limit |
Number |
The maximum number of items to return per page. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get metadata template by name
<box:get-metadata-templates-schema-by-scope-template-key>
Retrieves a metadata template by its scope
and templateKey
values. To find the scope
and templateKey
for a template, list all templates for an enterprise or globally, or list all templates applied to a file or folder. This operation makes an HTTP GET request to the /metadata_templates/{scope}/{template_key}/schema endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
scope |
Enumeration, one of:
|
The scope of the metadata template |
X |
|
Template key |
String |
The name of the metadata template |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get events long poll endpoint
<box:get-options-events>
Returns a list of realtime servers that can be used for long-polling updates to the [event stream](#get-events). In long polling, an HTTP request is kept open until the server sends a response, and the process is repeated over and over to receive updated responses. Long polling the event stream can only be used for user events, not for enterprise events.
To use long polling:
-
First, use this endpoint to retrieve a list of long poll URLs.
-
Next, make a long poll request to any of the provided URLs.
When an event occurs in monitored account a response with the value
new_change
will be sent. The response contains no other details as it only serves as a prompt to take further action such as sending a request to the [events endpoint](#get-events) with the last knownstream_position
. -
After the server sends this response, it closes the connection.
-
You must now repeat the long poll process to begin listening for events again.
If no events occur for a while and the connection times out, you will receive a response with the value
reconnect
. When you receive this response, you’ll make another call to this endpoint to restart the process. If you receive no events inretry_timeout
seconds then you will need to make another request to the real-time server (one of the URLs in the response for this endpoint). This might be necessary due to network errors. -
Finally, if you receive a
max_retries
error when making a request to the realtime server, you should start over by making a call to this endpoint first.
This operation makes an HTTP OPTIONS request to the /events endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Preflight check before upload
<box:get-options-files-content>
Performs a check to verify that a file will be accepted by Box before you upload the entire file. This operation makes an HTTP OPTIONS request to the /files/content endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List recently accessed items
<box:get-recent-items>
Returns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed. This operation makes an HTTP GET request to the /recent_items endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
limit |
Number |
The maximum number of items to return per page. |
||
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List retention policies
<box:get-retention-policies>
Retrieves all of the retention policies for an enterprise. This operation makes an HTTP GET request to the /retention_policies endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Policy name |
String |
Filters results by a case sensitive prefix of the name of retention policies. |
||
Policy type |
Enumeration, one of:
|
Filters results by the type of retention policy. |
||
Created by user id |
String |
Filters results by the ID of the user who created policy. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List retention policy assignments
<box:get-retention-policies-assignments-by-retention-policy-id>
Returns a list of all retention policy assignments associated with a specified retention policy. This operation makes an HTTP GET request to the /retention_policies/{retention_policy_id}/assignments endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Retention policy id |
String |
The ID of the retention policy. |
X |
|
type |
Enumeration, one of:
|
The type of the retention policy assignment to retrieve. |
||
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
limit |
Number |
The maximum number of items to return per page. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get retention policy
<box:get-retention-policies-by-retention-policy-id>
Retrieves a retention policy. This operation makes an HTTP GET request to the /retention_policies/{retention_policy_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Retention policy id |
String |
The ID of the retention policy. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get retention policy assignment
<box:get-retention-policy-assignments-by-retention-policy-assignment-id>
Retrieves a retention policy assignment This operation makes an HTTP GET request to the /retention_policy_assignments/{retention_policy_assignment_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Retention policy assignment id |
String |
The ID of the retention policy assignment. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Search for content
<box:get-search>
Searches for files, folders, web links, and shared files across the users content or across the entire enterprise. This operation makes an HTTP GET request to the /search endpoint.
Parameters
Name | Type | Description | Default Value | Required | ||
---|---|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|||
query |
String |
The string to search for. This query is matched against item names, descriptions, text content of files, and various other fields of the different item types. This parameter supports a variety of operators to further refine the results returns.
This field is required unless the `mdfilters` parameter is defined. |
||||
scope |
Enumeration, one of:
|
Limits the search results to either the files that the user has access to, or to files available to the entire enterprise. The scope defaults to |
USER_CONTENT |
|||
File extensions |
Array of String |
Limits the search results to any files that match any of the provided file extensions. This list is a comma-separated list of file extensions without the dots. |
||||
Created at range |
Array of String |
Limits the search results to any items created within a given date range. Date ranges are defined as comma-separated RFC3339 timestamps. If the the start date is omitted ( |
||||
Updated at range |
Array of String |
Limits the search results to any items updated within a given date range. Date ranges are defined as comma-separated RFC3339 timestamps. If the start date is omitted ( |
||||
Size range |
Array of Number |
Limits the search results to any items with a size within a given file size range. This applies to files and folders. Size ranges are defined as a comma-separated list of a lower and upper byte size limit (inclusive). The upper and lower bound can be omitted to create open ranges. |
||||
Owner user ids |
Array of String |
Limits the search results to any items that are owned by the given list of owners, defined as a list of comma separated user IDs. Please note that the items still need to be owned or shared with the currently authenticated user for them to show up in the search results. If the user does not have access to any files owned by any of the users an empty result set will be returned. To search across an entire enterprise, use the |
||||
Ancestor folder ids |
Array of String |
Limits the search results to items within the given list of folders, defined as a comma-separated lists of folder IDs. Search results will also include items within any subfolders of those ancestor folders. Please note that the folders still need to be owned or shared with the currently authenticated user. If the folder is not accessible by this user, or it does not exist, a |
||||
Content types |
Array of Enumeration, one of:
|
Limits the search results to any items that match the search query for a specific part of the file, for example the file description. Content types are defined as a comma-separated list of Box-recognized content types. The allowed content types are as follows:
|
||||
type |
Enumeration, one of:
|
Limits the search results to any items of this type. This parameter accepts only one value. By default, the API returns items that match any of these types:
|
||||
Trash content |
Enumeration, one of:
|
Determines if the search should look in the trash for items. By default, this API returns only search results for items not currently in the trash (
|
NON_TRASHED_ONLY |
|||
mdfilters |
Array of String |
Limits the search results to any items for which the metadata matches the provided filter. This parameter contains a list of 1 metadata template to filter the search results by. This list can currently only contain one entry. This parameter is required unless the |
||||
sort |
Enumeration, one of:
|
Defines the order in which search results are returned. This API defaults to returning items by relevance unless this parameter is explicitly specified:
|
RELEVANCE |
|||
direction |
Enumeration, one of:
|
Defines the direction in which search results are ordered. This API defaults to returning items in descending ( |
DESC |
|||
limit |
Number |
Defines the maximum number of items to return as part of a page of results. |
30 |
|||
Include recent shared links |
Boolean |
Defines whether the search results should include any items that the user recently accessed through a shared link. Note that when this parameter is set to true, the format of the response of this API changes to return a list of [Search Results with Shared Links](r://search_results_with_shared_links) |
false |
|||
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||||
offset |
Number |
The offset of the item at which to begin the response. |
0 |
|||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||||
Custom Query Parameters |
Object |
#[null] |
||||
Custom Headers |
Object |
|||||
Response Timeout |
Number |
The timeout for request to the remote service. |
||||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|||
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Find file for shared link
<box:get-shared-items>
Return the file represented by a shared link. A shared file can be represented by a shared link, which can originate within the current enterprise or within another. This endpoint allows an application to retrieve information about a shared file when only given a shared link. This operation makes an HTTP GET request to the /shared_items endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
If none match |
String |
Ensures an item is only returned if it has changed. Pass in the item’s last observed |
||
boxapi |
String |
A header containing the shared link and optional password for the shared link. The format for this header is as follows. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Find folder for shared link
<box:get-shared-itemsfolders>
Return the folder represented by a shared link. A shared folder can be represented by a shared link, which can originate within the current enterprise or within another. This endpoint allows an application to retrieve information about a shared folder when only given a shared link. This operation makes an HTTP GET request to the /shared_items#folders endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
If none match |
String |
Ensures an item is only returned if it has changed. Pass in the item’s last observed |
||
boxapi |
String |
A header containing the shared link and optional password for the shared link. The format for this header is as follows. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List storage policies
<box:get-storage-policies>
Fetches all the storage policies in the enterprise. This operation makes an HTTP GET request to the /storage_policies endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
limit |
Number |
The maximum number of items to return per page. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get storage policy
<box:get-storage-policies-by-storage-policy-id>
Fetches a specific storage policy. This operation makes an HTTP GET request to the /storage_policies/{storage_policy_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Storage policy id |
String |
The ID of the storage policy. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List storage policy assignments
<box:get-storage-policy-assignments>
Fetches all the storage policy assignment for an enterprise or user. This operation makes an HTTP GET request to the /storage_policy_assignments endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
Resolved for type |
Enumeration, one of:
|
The target type to return assignments for |
X |
|
Resolved for id |
String |
The ID of the user or enterprise to return assignments for |
X |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get storage policy assignment
<box:get-storage-policy-assignments-by-storage-policy-assignment-id>
Fetches a specific storage policy assignment. This operation makes an HTTP GET request to the /storage_policy_assignments/{storage_policy_assignment_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Storage policy assignment id |
String |
The ID of the storage policy assignment. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get task assignment
<box:get-task-assignments-by-task-assignment-id>
Retrieves information about a task assignment. This operation makes an HTTP GET request to the /task_assignments/{task_assignment_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Task assignment id |
String |
The ID of the task assignment. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List task assignments
<box:get-tasks-assignments-by-task-id>
Lists all of the assignments for a given task. This operation makes an HTTP GET request to the /tasks/{task_id}/assignments endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Task id |
String |
The ID of the task. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get task
<box:get-tasks-by-task-id>
Retrieves information about a specific task. This operation makes an HTTP GET request to the /tasks/{task_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Task id |
String |
The ID of the task. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List terms of service user statuses
<box:get-terms-of-service-user-statuses>
Retrieves an overview of users and their status for a terms of service, including Whether they have accepted the terms and when. This operation makes an HTTP GET request to the /terms_of_service_user_statuses endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Tos id |
String |
The ID of the terms of service. |
X |
|
User id |
String |
Limits results to the given user ID. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List terms of services
<box:get-terms-of-services>
Returns the current terms of service text and settings for the enterprise. This operation makes an HTTP GET request to the /terms_of_services endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Tos type |
Enumeration, one of:
|
Limits the results to the terms of service of the given type. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get terms of service
<box:get-terms-of-services-by-terms-of-service-id>
Fetches a specific terms of service. This operation makes an HTTP GET request to the /terms_of_services/{terms_of_service_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Terms of service id |
String |
The ID of the terms of service. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List enterprise users
<box:get-users>
Returns a list of all users for the enterprise, along with their user_id
, public_name
, and login
. The application and the authenticated user must have the permission to look up users in the entire enterprise. This operation makes an HTTP GET request to the /users endpoint.
The operation automatically paginates the results using offset pagination.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Filter term |
String |
Limits the results to only users who’s |
||
User type |
Enumeration, one of:
|
Limits the results to the kind of user specified.
|
||
External app user id |
String |
Limits the results to app users with the given |
||
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
offset |
Number |
The offset of the item at which to begin the response. |
0 |
|
limit |
Number |
The maximum number of items to return per page. |
||
DO NOT USE - usemarker |
Boolean |
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 |
false |
|
DO NOT USE - marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get user avatar
<box:get-users-avatar-by-user-id>
Retrieves an image of a the user’s avatar. This operation makes an HTTP GET request to the /users/{user_id}/avatar endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
User id |
String |
The ID of the user. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get user
<box:get-users-by-user-id>
Retrieves information about a user in the enterprise. The application and the authenticated user must have the permission to look up users in the entire enterprise. This endpoint also returns a limited set of information for external users who are collaborated on content owned by the enterprise for authenticated users with the right scopes. In this case, disallowed fields will return null instead. This operation makes an HTTP GET request to the /users/{user_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
User id |
String |
The ID of the user. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List user’s email aliases
<box:get-users-email-aliases-by-user-id>
Retrieves all email aliases for a user. The collection does not include the primary login for the user. This operation makes an HTTP GET request to the /users/{user_id}/email_aliases endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
User id |
String |
The ID of the user. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get current user
<box:get-users-me>
Retrieves information about the user who is currently authenticated. In the case of a client-side authenticated OAuth 2.0 application, this is the user who authorized the app. In the case of a JWT, server-side authenticated application, this is the service account that belongs to the application by default. Use the As-User
header to change who this API call is made on behalf of. This operation makes an HTTP GET request to the /users/me endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List user’s groups
<box:get-users-memberships-by-user-id>
Retrieves all the groups for a user. 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 /users/{user_id}/memberships endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
User id |
String |
The ID of the user. |
X |
|
limit |
Number |
The maximum number of items to return per page. |
||
offset |
Number |
The offset of the item at which to begin the response. |
0 |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get web link
<box:get-web-links-by-web-link-id>
Retrieve information about a web link. This operation makes an HTTP GET request to the /web_links/{web_link_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Web link id |
String |
The ID of the web link. |
X |
|
boxapi |
String |
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 |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get trashed web link
<box:get-web-links-trash-by-web-link-id>
Retrieves a web link that has been moved to the trash. This operation makes an HTTP GET request to the /web_links/{web_link_id}/trash endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Web link id |
String |
The ID of the web link. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
List all webhooks
<box:get-webhooks>
Returns all defined webhooks for the requesting application. This API returns only webhooks that are applied to files or folders that are owned by the authenticated user. This means that an admin cannot see webhooks created by a service account unless the admin has access to those folders, and vice versa. This operation makes an HTTP GET request to the /webhooks endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
marker |
String |
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires |
||
limit |
Number |
The maximum number of items to return per page. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get webhook
<box:get-webhooks-by-webhook-id>
Retrieves a specific webhook This operation makes an HTTP GET request to the /webhooks/{webhook_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Webhook id |
String |
The ID of the webhook. |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Download zip archive
<box:get-zip-downloads-content-by-zip-download-id>
Returns the contents of a ZIP archive in binary format. This URL does not require any form of authentication and could be used in a user’s browser to download the archive to a user’s device. By default, this URL is only valid for a few seconds from the creation of the request for this archive.
After a download has started it cannot be stopped and resumed, instead a new request for a ZIP archive must be created. The URL of this endpoint should not be considered as fixed. Instead, use the [Create zip download](e://post_zip_downloads) API to request the creation of a ZIP archive, and then follow the download_url
field in the response to this endpoint.
This operation makes an HTTP GET request to the /zip_downloads/{zip_download_id}/content endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
(DEPRECATED) Zip download id |
String |
The unique identifier that represents this |
X |
|
Zip download URL generated by 'Create zip download' operation |
String |
The temporary URL to download the |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get zip download status
<box:get-zip-downloads-status-by-zip-download-id>
Returns the download status of a ZIP archive, allowing an application to inspect the progress of the download as well as the number of items that might have been skipped. This endpoint can only be accessed after the download has started. Subsequently, this endpoint is valid for 12 hours from the start of the download. The URL of this endpoint should not be considered as fixed. Instead, use the [Create zip download](e://post_zip_downloads) API to request the creation of a ZIP archive, and then follow the status_url
field in the response to this endpoint.
This operation makes an HTTP GET request to the /zip_downloads/{zip_download_id}/status endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Zip download id |
String |
The unique identifier that represent this |
X |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Unauthorize
<box:unauthorize>
Deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without repeating the authorization dance.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Resource Owner Id |
String |
The id of the resource owner which access should be invalidated |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
PUpdate collaboration
<box:update-collaborations-by-collaboration-id>
Updates a collaboration. Can be used to change the owner of an item, or to accept collaboration invites. This operation makes an HTTP PUT request to the /collaborations/{collaboration_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Collaboration id |
String |
The ID of the collaboration |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update comment
<box:update-comments-by-comment-id>
Updates the message of a comment. This operation makes an HTTP PUT request to the /comments/{comment_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Comment id |
String |
The ID of the comment. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update file request
<box:update-file-requests-by-file-request-id>
Updates a file request. This can be used to activate or deactivate a file request. This operation makes an HTTP PUT request to the /file_requests/{file_request_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File request id |
String |
The unique identifier that represents a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
If match |
String |
Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add shared link to file
<box:update-files-add-shared-link-by-file-id>
Adds a shared link to a file. This operation makes an HTTP PUT request to the /files/{file_id}#add_shared_link endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
String |
Explicitly request the |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update file
<box:update-files-by-file-id>
Updates a file. This can be used to rename or move a file, create a shared link, or lock a file. This operation makes an HTTP PUT request to the /files/{file_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
If match |
String |
Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update metadata instance on file
<box:update-files-metadata-by-file-id-scope-template-key>
Updates a piece of metadata on a file. The metadata instance can only be updated if the template has already been applied to the file before. When editing metadata, only values that match the metadata template schema will be accepted. The update is applied atomically. If any errors occur during the application of the operations, the metadata instance will not be changed. This operation makes an HTTP PUT request to the /files/{file_id}/metadata/{scope}/{template_key} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
scope |
Enumeration, one of:
|
The scope of the metadata template |
X |
|
Template key |
String |
The name of the metadata template |
X |
|
Body |
Array of Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update classification on file
<box:update-files-metadata-enterprise-security-classification6vmvochw-uwo-by-file-id>
Updates a classification on a file. The classification can only be updated if a classification has already been applied to the file before. When editing classifications, only values are defined for the enterprise will be accepted. This operation makes an HTTP PUT request to the /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Body |
Array of Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Box Skill cards on file
<box:update-files-metadata-global-box-skills-cards-by-file-id>
Updates one or more Box Skills metadata cards to a file. This operation makes an HTTP PUT request to the /files/{file_id}/metadata/global/boxSkillsCards endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Body |
Array of Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove shared link from file
<box:update-files-remove-shared-link-by-file-id>
Removes a shared link from a file. This operation makes an HTTP PUT request to the /files/{file_id}#remove_shared_link endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
String |
Explicitly request the |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update shared link on file
<box:update-files-update-shared-link-by-file-id>
Updates a shared link on a file. This operation makes an HTTP PUT request to the /files/{file_id}#update_shared_link endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
String |
Explicitly request the |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Upload part of file
<box:update-files-upload-sessions-by-upload-session-id>
Updates a chunk of an upload session for a file. This operation makes an HTTP PUT request to the /files/upload_sessions/{upload_session_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Upload session id |
String |
The ID of the upload session. |
X |
|
digest |
String |
The [RFC3230][1] message digest of the chunk uploaded. Only SHA1 is supported. The SHA1 digest must be Base64 encoded. The format of this header is as |
X |
|
Content range |
String |
The byte range of the chunk. Must not overlap with the range of a part already uploaded this session. |
X |
|
Body |
String |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Apply watermark to file
<box:update-files-watermark-by-file-id>
Applies or update a watermark on a file. This operation makes an HTTP PUT request to the /files/{file_id}/watermark endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
File id |
String |
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add shared link to folder
<box:update-folders-add-shared-link-by-folder-id>
Adds a shared link to a folder. This operation makes an HTTP PUT request to the /folders/{folder_id}#add_shared_link endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
String |
Explicitly request the |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update folder
<box:update-folders-by-folder-id>
Updates a folder. This can be also be used to move the folder, create shared links, update collaborations, and more. This operation makes an HTTP PUT request to the /folders/{folder_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
If match |
String |
Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update metadata instance on folder
<box:update-folders-metadata-by-folder-id-scope-template-key>
Updates a piece of metadata on a folder. The metadata instance can only be updated if the template has already been applied to the folder before. When editing metadata, only values that match the metadata template schema will be accepted. The update is applied atomically. If any errors occur during the application of the operations, the metadata instance will not be changed. This operation makes an HTTP PUT request to the /folders/{folder_id}/metadata/{scope}/{template_key} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
scope |
Enumeration, one of:
|
The scope of the metadata template |
X |
|
Template key |
String |
The name of the metadata template |
X |
|
Body |
Array of Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update classification on folder
<box:update-folders-metadata-enterprise-security-classification6vmvochw-uwo-by-folder-id>
Updates a classification on a folder. The classification can only be updated if a classification has already been applied to the folder before. When editing classifications, only values are defined for the enterprise will be accepted. This operation makes an HTTP PUT request to the /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Body |
Array of Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove shared link from folder
<box:update-folders-remove-shared-link-by-folder-id>
Removes a shared link from a folder. This operation makes an HTTP PUT request to the /folders/{folder_id}#remove_shared_link endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
String |
Explicitly request the |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update shared link on folder
<box:update-folders-update-shared-link-by-folder-id>
Updates a shared link on a folder. This operation makes an HTTP PUT request to the /folders/{folder_id}#update_shared_link endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
fields |
String |
Explicitly request the |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Apply watermark to folder
<box:update-folders-watermark-by-folder-id>
Applies or update a watermark on a folder. This operation makes an HTTP PUT request to the /folders/{folder_id}/watermark endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Folder id |
String |
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update group membership
<box:update-group-memberships-by-group-membership-id>
Updates a user’s 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 PUT request to the /group_memberships/{group_membership_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Group membership id |
String |
The ID of the group membership. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update group
<box:update-groups-by-group-id>
Updates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API. This operation makes an HTTP PUT request to the /groups/{group_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Group id |
String |
The ID of the group. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update legal hold policy
<box:update-legal-hold-policies-by-legal-hold-policy-id>
Updates a legal hold policy. This operation makes an HTTP PUT request to the /legal_hold_policies/{legal_hold_policy_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Legal hold policy id |
String |
The ID of the legal hold policy |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add classification
<box:update-metadata-templates-enterprise-security-classification6vmvochw-uwo-schemaadd>
Adds one or more new classifications to the list of classifications available to the enterprise. This API can also be called by including the enterprise ID in the URL explicitly, for example /metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema
. This operation makes an HTTP PUT request to the /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Array of Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete classification
<box:update-metadata-templates-enterprise-security-classification6vmvochw-uwo-schemadelete>
Removes a classification from the list of classifications available to the enterprise. This API can also be called by including the enterprise ID in the URL explicitly, for example /metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema
. This operation makes an HTTP PUT request to the /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Array of Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update classification
<box:update-metadata-templates-enterprise-security-classification6vmvochw-uwo-schemaupdate>
Updates the labels and descriptions of one or more classifications available to the enterprise. This API can also be called by including the enterprise ID in the URL explicitly, for example /metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema
. This operation makes an HTTP PUT request to the /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Body |
Array of Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update metadata template
<box:update-metadata-templates-schema-by-scope-template-key>
Updates a metadata template. The metadata template can only be updated if the template already exists. The update is applied atomically. If any errors occur during the application of the operations, the metadata template will not be changed. This operation makes an HTTP PUT request to the /metadata_templates/{scope}/{template_key}/schema endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
scope |
Enumeration, one of:
|
The scope of the metadata template |
X |
|
Template key |
String |
The name of the metadata template |
X |
|
Body |
Array of Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update retention policy
<box:update-retention-policies-by-retention-policy-id>
Updates a retention policy. This operation makes an HTTP PUT request to the /retention_policies/{retention_policy_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Retention policy id |
String |
The ID of the retention policy. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update all Box Skill cards on file
<box:update-skill-invocations-by-skill-id>
An alternative method that can be used to overwrite and update all Box Skill metadata cards on a file. This operation makes an HTTP PUT request to the /skill_invocations/{skill_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Skill id |
String |
The ID of the skill to apply this metadata for. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update storage policy assignment
<box:update-storage-policy-assignments-by-storage-policy-assignment-id>
Updates a specific storage policy assignment. This operation makes an HTTP PUT request to the /storage_policy_assignments/{storage_policy_assignment_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Storage policy assignment id |
String |
The ID of the storage policy assignment. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update task assignment
<box:update-task-assignments-by-task-assignment-id>
Updates a task assignment. This endpoint can be used to update the state of a task assigned to a user. This operation makes an HTTP PUT request to the /task_assignments/{task_assignment_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Task assignment id |
String |
The ID of the task assignment. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update task
<box:update-tasks-by-task-id>
Updates a task. This can be used to update a task’s configuration, or to update its completion state. This operation makes an HTTP PUT request to the /tasks/{task_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Task id |
String |
The ID of the task. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update terms of service status for existing user
<box:update-terms-of-service-user-statuses-by-terms-of-service-user-status-id>
Updates the status for a terms of service for a user. This operation makes an HTTP PUT request to the /terms_of_service_user_statuses/{terms_of_service_user_status_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Terms of service user status id |
String |
The ID of the terms of service status. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update terms of service
<box:update-terms-of-services-by-terms-of-service-id>
Updates a specific terms of service. This operation makes an HTTP PUT request to the /terms_of_services/{terms_of_service_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Terms of service id |
String |
The ID of the terms of service. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update user
<box:update-users-by-user-id>
Updates a managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions. This operation makes an HTTP PUT request to the /users/{user_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
User id |
String |
The ID of the user. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Transfer owned folders
<box:update-users-folders0-by-user-id>
Moves all of the items (files, folders and workflows) owned by a user into another user’s account. Only the root folder (0
) can be transferred. Folders can only be moved across users by users with administrative permissions.
This call is performed synchronously, which might lead to a slow response when the source user has a large number of items in all of their folders. If the destination path has a metadata cascade policy attached to any of the parent folders, a metadata cascade operation is kicked off asynchronously. There is currently no way to check for when this operation is finished.
The destination folder’s name will be in the format {User}'s Files and Folders
, where {User}
is the display name of the user.
To make this API call, your application must have the Read and write all files and folders stored in Box
scope enabled. Ensure the destination user has access to Relay
or Relay Lite
, and has access to the files and folders involved in the workflows being transferred. Admins will receive an email when the operation is completed.
This operation makes an HTTP PUT request to the /users/{user_id}/folders/0 endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
User id |
String |
The ID of the user. |
X |
|
fields |
Array of String |
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. |
||
notify |
Boolean |
Determines if users should receive email notification for the action performed. |
false |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update web link
<box:update-web-links-by-web-link-id>
Updates a web link object. This operation makes an HTTP PUT request to the /web_links/{web_link_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Web link id |
String |
The ID of the web link. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update webhook
<box:update-webhooks-by-webhook-id>
Updates a webhook. This operation makes an HTTP PUT request to the /webhooks/{webhook_id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
X |
|
Webhook id |
String |
The ID of the webhook. |
X |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
X |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
On Download File Trigger
<box:on-download-file-listener>
Initiates a flow when a download file event occurs.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Folder ID |
String |
ID of the folder. |
x |
|
Include sub-folders |
Boolean |
Determines whether to include subfolders or not. |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Primary Node Only |
Boolean |
Whether this source should only be executed on the primary node when running in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
On New File in Folder
<box:on-new-file-in-folder-listener>
Initiates a flow when a file is created in a folder.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Folder ID |
String |
ID of the folder. |
x |
|
Include sub-folders |
Boolean |
Determines whether to include subfolders or not. |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Primary Node Only |
Boolean |
Whether this source should only be executed on the primary node when running in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
On New Folder
<box:on-new-folder-listener>
Initiates a flow when a folder is created in a folder.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Folder ID |
String |
ID of the folder. |
x |
|
Include sub-folders |
Boolean |
Determines whether to include subfolders or not. |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Primary Node Only |
Boolean |
Whether this source should only be executed on the primary node when running in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
On New Task Created
<box:on-new-task-created-listener>
Initiates a flow when a task assignment is created.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Assigned To |
String |
The user to assign the task to. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Primary Node Only |
Boolean |
Whether this source should only be executed on the primary node when running in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Types
Proxy
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Host |
String |
x |
||
Port |
Number |
x |
||
Username |
String |
|||
Password |
String |
|||
Non Proxy Hosts |
String |
Reconnection
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fails Deployment |
Boolean |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy |
||
Reconnection Strategy |
The reconnection strategy to use |
Reconnect
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often (in ms) to reconnect |
||
Blocking |
Boolean |
If false, the reconnection strategy will run in a separate, non-blocking thread |
||
Count |
Number |
How many reconnection attempts to make |
Reconnect Forever
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often (in ms) to reconnect |
||
Blocking |
Boolean |
If false, the reconnection strategy runs in a separate, non-blocking thread. |
Tls
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Enabled Protocols |
String |
A comma-separated list of protocols enabled for this context. |
||
Enabled Cipher Suites |
String |
A comma-separated list of cipher suites enabled for this context. |
||
Trust Store |
||||
Key Store |
||||
Revocation Check |
Trust Store
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store. |
||
Password |
String |
The password used to protect the trust store. |
||
Type |
String |
The type of store used. |
||
Algorithm |
String |
The algorithm used by the trust store. |
||
Insecure |
Boolean |
If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk. |
Key Store
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the key store. |
||
Type |
String |
The type of store used. |
||
Alias |
String |
When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. |
||
Key Password |
String |
The password used to protect the private key. |
||
Password |
String |
The password used to protect the key store. |
||
Algorithm |
String |
The algorithm used by the key store. |
Standard Revocation Check
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Only End Entities |
Boolean |
Only verify the last element of the certificate chain. |
||
Prefer Crls |
Boolean |
Try CRL instead of OCSP first. |
||
No Fallback |
Boolean |
Do not use the secondary checking method (the one not selected before). |
||
Soft Fail |
Boolean |
Avoid verification failure when the revocation server can not be reached or is busy. |
Custom Ocsp Responder
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Url |
String |
The URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response (must be in the trust store), if present. |
Expiration Policy
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Idle Time |
Number |
A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration |
||
Time Unit |
Enumeration, one of:
|
A time unit that qualifies the maxIdleTime attribute |
Http Response Attributes
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Status Code |
Number |
x |
||
Headers |
Object |
x |
||
Reason Phrase |
String |
x |
Repeatable In Memory Stream
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. |
||
Buffer Size Increment |
Number |
This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. |
||
Max Buffer Size |
Number |
This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which all these attributes are expressed |
Repeatable File Store Stream
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
In Memory Size |
Number |
Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |
Redelivery Policy
Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Redelivery Count |
Number |
Maximum number of times that a delivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error. |
||
Message Digest Algorithm |
String |
Secure hashing algorithm to use if the Use Secure Hash field is |
||
Message Identifier |
Configures the non-repeatable streaming strategy by which Mule disables repeatable streams. Use this strategy if your use case requires reading the content only once. |
|||
Object Store |
ObjectStore |
Configures the object store that stores the redelivery counter for each message. |
Redelivery Policy Message Identifier
Configures how to identify a redelivered message and how to find out when the message was redelivered.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Use Secure Hash |
Boolean |
If |
||
Id Expression |
String |
Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if the Use Secure Hash field is false. |
Repeatable In Memory Iterable
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
This is the number of instances initially allowed to be kept in memory in order to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it will be expanded according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances. |
100 |
|
Buffer Size Increment |
Number |
This is by how much the buffer size will be expanded if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, and that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. Default value is 100 instances. |
100 |
|
Max Buffer Size |
Number |
This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit. |
Repeatable File Store Iterable
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
In Memory Objects |
Number |
This is the maximum amount of instances that will be kept in memory. If more than that is required, then it will start to buffer the content on disk. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |