---
schema_version: "1"
id: 3127a1428fb8ec10c47384f92f62cbc945712d5356ec52ba38735f01afd09a3e
title: Box Connector Reference 5.3
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/box-connector/latest/box-connector-reference.md
canonical_url: https://docs.mulesoft.com/box-connector/latest/box-connector-reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 3d78482062fc07dfdb6497259685babdb55265c691c9d0da91baf96bd33b9fa5
description: MuleSoft Documentation Site
release: "5.3"
latest: true
---
---
product: Box Connector
version: 5.3
is-latest-version: true
---

# Box Connector Reference 5.3

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

> [!NOTE] This topic is large and might take longer than usual to load in your browser. Allow extra
> time for the content to render or switch to another browser.

> [!NOTE] 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>Name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Connection</p></td><td><div><div><ul><li><p><a href="#Config_Connection">JWT</a></p></li><li><p><a href="#Config_Oauth2security">Oauth2security Connection Provider</a></p></li></ul></div></div></td><td><p>Connection types to provide to this configuration.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td><p>1</p></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td><p>MINUTES</p></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td><p>AUTO</p></td><td></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The identifier of this element used to reference it in other components</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr></tbody></table>

#### Connection Types

##### JWT

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Default Headers</p></td><td><div><div><p>Array of <a href="#DefaultHeader">Default Header</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Query Parameters</p></td><td><div><div><p>Array of <a href="#DefaultQueryParam">Default Query Param</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for establishing connections to the remote service</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit which qualifies the <strong>Connection Timeout</strong>.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Use Persistent Connections</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If false, each connection will be closed after the first request is completed.</p></td><td><p>true</p></td><td></td></tr><tr><td><p>Max Connections</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of outbound connections that will be kept open at the same time</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Connection Idle Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>A timeout for how long a connection can remain idle before it is closed</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Idle Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the connection <strong>Idle Timeout</strong>.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Proxy Config</p></td><td><div><div><p><a href="#Proxy">Proxy</a></p></div></div></td><td><p>Reusable configuration element for outbound connections through a proxy</p></td><td></td><td></td></tr><tr><td><p>Stream Response</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether or not received responses should be streamed</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Response Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The space in bytes for the buffer where the HTTP response will be stored.</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Client ID</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>X</p></td></tr><tr><td><p>Client Secret</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>X</p></td></tr><tr><td><p>Public Key Id</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the Public Key configured in your Box instance to authenticate the application.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Entity Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of the Entity ID: EnterpriseId or UserId</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Box Sub Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ENTERPRISE</p></li><li><p>USER</p></li></ul></div></div></td><td><p>The box sub type: enterprise or user</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Algorithm</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>RS256</p></li><li><p>RS384</p></li><li><p>RS512</p></li></ul></div></div></td><td><p>The RSA encryption algorithm used to encrypt the private key.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Keystore</p></td><td><div><div><p>String</p></div></div></td><td><p>Path to keystore</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Keystore Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Keystore type: JKS, PKCS12, BCFKS, etc.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Store Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password of key store</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Key Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>Alias which identifies the key</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Key Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Key password</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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</p></td><td></td><td></td></tr></tbody></table>

##### 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](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2),
[Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub),
or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Default Headers</p></td><td><div><div><p>Array of <a href="#DefaultHeader">Default Header</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Query Parameters</p></td><td><div><div><p>Array of <a href="#DefaultQueryParam">Default Query Param</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for establishing connections to the remote service</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit which qualifies the <strong>Connection Timeout</strong>.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Use Persistent Connections</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If false, each connection is closed after the first request is completed.</p></td><td><p>true</p></td><td></td></tr><tr><td><p>Max Connections</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of outbound connections to keep open concurrently.</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Connection Idle Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>A timeout for how long a connection can remain idle before it is closed.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Idle Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit which qualifies the connection <strong>Idle Timeout</strong>.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Proxy Config</p></td><td><div><div><p><a href="#Proxy">Proxy</a></p></div></div></td><td><p>Reusable configuration element for outbound connections through a proxy.</p></td><td></td><td></td></tr><tr><td><p>Stream Response</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether or not to stream received responses.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Response Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The space in bytes for the buffer where the HTTP response is stored.</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Protocol</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HTTP</p></li><li><p>HTTPS</p></li></ul></div></div></td><td><p>Protocol to use for communication. Valid values are HTTP and HTTPS.</p></td><td><p>HTTP</p></td><td></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth consumerKey, as registered with the service provider.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Consumer Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth consumerSecret, as registered with the service provider.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Authorization Url</p></td><td><div><div><p>String</p></div></div></td><td><p>Service provider’s authorization endpoint URL</p></td><td><p><code>https://account.box.com/api/oauth2/authorize</code></p></td><td></td></tr><tr><td><p>Access Token Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The service provider’s accessToken endpoint URL</p></td><td><p><code>https://api.box.com/oauth2/token</code></p></td><td></td></tr><tr><td><p>Scopes</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth scopes to request during the OAuth dance. If not provided, the values default to those in the annotation.</p></td><td><div><div><ul><li><p>root_readwrite</p></li><li><p>manage_app_users</p></li><li><p>manage_managed_users</p></li><li><p>manage_groups</p></li><li><p>manage_webhook</p></li></ul></div></div></td><td></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Resource owner ID each component should use if the resource owner ID is not otherwise referenced.</p></td><td></td><td></td></tr><tr><td><p>Before</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a flow to execute immediately before starting the OAuth dance.</p></td><td></td><td></td></tr><tr><td><p>After</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a flow to execute immediately after an access token is received.</p></td><td></td><td></td></tr><tr><td><p>Listener Config</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to an <code>&lt;http:listener-config /&gt;</code> to use to create the listener that will receive the access token callback endpoint.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Callback Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path of the access token callback endpoint</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Authorize Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path of the local http endpoint which triggers the OAuth dance</p></td><td></td><td><p>X</p></td></tr><tr><td><p>External Callback Url</p></td><td><div><div><p>String</p></div></div></td><td><p>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</p></td><td></td><td></td></tr><tr><td><p>Object Store</p></td><td><div><div><p>String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr></tbody></table>

## Associated Operations

- [Add domain to list of allowed collaboration domains](#CreateCollaborationWhitelistEntries)

- [Create user exemption from collaboration domain restrictions](#CreateCollaborationWhitelistExemptTargets)

- [Create collaboration](#CreateCollaborations)

- [Create comment](#CreateComments)

- [Copy file request](#CreateFileRequestsCopyByFileRequestId)

- [Restore file](#CreateFilesByFileId)

- [Upload file](#CreateFilesContent)

- [Upload file version](#CreateFilesContentByFileId)

- [Copy file](#CreateFilesCopyByFileId)

- [Create metadata instance on file](#CreateFilesMetadataByFileIdScopeTemplateKey)

- [Add classification to file](#CreateFilesMetadataEnterpriseSecurityClassification6vmvochwUwoByFileId)

- [Create Box Skill cards on file](#CreateFilesMetadataGlobalBoxSkillsCardsByFileId)

- [Create upload session](#CreateFilesUploadSessions)

- [Create upload session for existing file](#CreateFilesUploadSessionsByFileId)

- [Commit upload session](#CreateFilesUploadSessionsCommitByUploadSessionId)

- [Revert file version](#CreateFilesVersionsCurrentByFileId)

- [Create folder lock on folder](#CreateFolderLocks)

- [Create folder](#CreateFolders)

- [Restore folder](#CreateFoldersByFolderId)

- [Copy folder](#CreateFoldersCopyByFolderId)

- [Create metadata instance on folder](#CreateFoldersMetadataByFolderIdScopeTemplateKey)

- [Add classification to folder](#CreateFoldersMetadataEnterpriseSecurityClassification6vmvochwUwoByFolderId)

- [Add user to group](#CreateGroupMemberships)

- [Create group](#CreateGroups)

- [Create user invite](#CreateInvites)

- [Create legal hold policy](#CreateLegalHoldPolicies)

- [Assign legal hold policy](#CreateLegalHoldPolicyAssignments)

- [Create metadata cascade policy](#CreateMetadataCascadePolicies)

- [Force-apply metadata cascade policy to folder](#CreateMetadataCascadePoliciesApplyByMetadataCascadePolicyId)

- [Query files and folders by metadata](#CreateMetadataQueriesExecuteRead)

- [Create metadata template](#CreateMetadataTemplatesSchema)

- [Add initial classifications](#CreateMetadataTemplatesSchemaclassifications)

- [Create retention policy](#CreateRetentionPolicies)

- [Assign retention policy](#CreateRetentionPolicyAssignments)

- [Assign storage policy](#CreateStoragePolicyAssignments)

- [Assign task](#CreateTaskAssignments)

- [Create task](#CreateTasks)

- [Create terms of service status for new user](#CreateTermsOfServiceUserStatuses)

- [Create terms of service](#CreateTermsOfServices)

- [Create user](#CreateUsers)

- [Create email alias](#CreateUsersEmailAliasesByUserId)

- [Create web link](#CreateWebLinks)

- [Restore web link](#CreateWebLinksByWebLinkId)

- [Create webhook](#CreateWebhooks)

- [Create zip download](#CreateZipDownloads)

- [Remove domain from list of allowed collaboration domains](#DeleteCollaborationWhitelistEntriesByCollaborationWhitelistEntryId)

- [Remove user from list of users exempt from domain restrictions](#DeleteCollaborationWhitelistExemptTargetsByCollaborationWhitelistExemptTargetId)

- [Remove collaboration](#DeleteCollaborationsByCollaborationId)

- [Remove comment](#DeleteCommentsByCommentId)

- [Remove device pin](#DeleteDevicePinnersByDevicePinnerId)

- [Delete file request](#DeleteFileRequestsByFileRequestId)

- [Delete file](#DeleteFilesByFileId)

- [Remove metadata instance from file](#DeleteFilesMetadataByFileIdScopeTemplateKey)

- [Remove classification from file](#DeleteFilesMetadataEnterpriseSecurityClassification6vmvochwUwoByFileId)

- [Remove Box Skill cards from file](#DeleteFilesMetadataGlobalBoxSkillsCardsByFileId)

- [Permanently remove file](#DeleteFilesTrashByFileId)

- [Remove upload session](#DeleteFilesUploadSessionsByUploadSessionId)

- [Remove file version](#DeleteFilesVersionsByFileIdFileVersionId)

- [Remove watermark from file](#DeleteFilesWatermarkByFileId)

- [Delete folder lock](#DeleteFolderLocksByFolderLockId)

- [Delete folder](#DeleteFoldersByFolderId)

- [Remove metadata instance from folder](#DeleteFoldersMetadataByFolderIdScopeTemplateKey)

- [Remove classification from folder](#DeleteFoldersMetadataEnterpriseSecurityClassification6vmvochwUwoByFolderId)

- [Permanently remove folder](#DeleteFoldersTrashByFolderId)

- [Remove watermark from folder](#DeleteFoldersWatermarkByFolderId)

- [Remove user from group](#DeleteGroupMembershipsByGroupMembershipId)

- [Remove group](#DeleteGroupsByGroupId)

- [Remove legal hold policy](#DeleteLegalHoldPoliciesByLegalHoldPolicyId)

- [Unassign legal hold policy](#DeleteLegalHoldPolicyAssignmentsByLegalHoldPolicyAssignmentId)

- [Remove metadata cascade policy](#DeleteMetadataCascadePoliciesByMetadataCascadePolicyId)

- [Delete all classifications](#DeleteMetadataTemplatesEnterpriseSecurityClassification6vmvochwUwoSchema)

- [Remove metadata template](#DeleteMetadataTemplatesSchemaByScopeTemplateKey)

- [Unassign storage policy](#DeleteStoragePolicyAssignmentsByStoragePolicyAssignmentId)

- [Unassign task](#DeleteTaskAssignmentsByTaskAssignmentId)

- [Remove task](#DeleteTasksByTaskId)

- [Delete user](#DeleteUsersByUserId)

- [Remove email alias](#DeleteUsersEmailAliasesByUserIdEmailAliasId)

- [Remove web link](#DeleteWebLinksByWebLinkId)

- [Permanently remove web link](#DeleteWebLinksTrashByWebLinkId)

- [Remove webhook](#DeleteWebhooksByWebhookId)

- [List allowed collaboration domains](#GetCollaborationWhitelistEntries)

- [Get allowed collaboration domain](#GetCollaborationWhitelistEntriesByCollaborationWhitelistEntryId)

- [List users exempt from collaboration domain restrictions](#GetCollaborationWhitelistExemptTargets)

- [Get user exempt from collaboration domain restrictions](#GetCollaborationWhitelistExemptTargetsByCollaborationWhitelistExemptTargetId)

- [List pending collaborations](#GetCollaborations)

- [Get collaboration](#GetCollaborationsByCollaborationId)

- [List all collections](#GetCollections)

- [List collection items](#GetCollectionsItemsByCollectionId)

- [Get comment](#GetCommentsByCommentId)

- [Get device pin](#GetDevicePinnersByDevicePinnerId)

- [List enterprise device pins](#GetEnterprisesDevicePinnersByEnterpriseId)

- [List user and enterprise events](#GetEvents)

- [Get file request](#GetFileRequestsByFileRequestId)

- [List file version legal holds](#GetFileVersionLegalHolds)

- [Get file version legal hold](#GetFileVersionLegalHoldsByFileVersionLegalHoldId)

- [List file version retentions](#GetFileVersionRetentions)

- [Get retention on file](#GetFileVersionRetentionsByFileVersionRetentionId)

- [Get file information](#GetFilesByFileId)

- [List file collaborations](#GetFilesCollaborationsByFileId)

- [List file comments](#GetFilesCommentsByFileId)

- [Download file](#GetFilesContentByFileId)

- [Get shared link for file](#GetFilesGetSharedLinkByFileId)

- [List metadata instances on file](#GetFilesMetadataByFileId)

- [Get metadata instance on file](#GetFilesMetadataByFileIdScopeTemplateKey)

- [Get classification on file](#GetFilesMetadataEnterpriseSecurityClassification6vmvochwUwoByFileId)

- [List Box Skill cards on file](#GetFilesMetadataGlobalBoxSkillsCardsByFileId)

- [List tasks on file](#GetFilesTasksByFileId)

- [Get file thumbnail](#GetFilesThumbnailByFileIdExtension)

- [Get trashed file](#GetFilesTrashByFileId)

- [Get upload session](#GetFilesUploadSessionsByUploadSessionId)

- [List parts](#GetFilesUploadSessionsPartsByUploadSessionId)

- [List all file versions](#GetFilesVersionsByFileId)

- [Get file version](#GetFilesVersionsByFileIdFileVersionId)

- [Get watermark on file](#GetFilesWatermarkByFileId)

- [List folder locks on folder](#GetFolderLocks)

- [Get folder information](#GetFoldersByFolderId)

- [List folder collaborations](#GetFoldersCollaborationsByFolderId)

- [Get shared link for folder](#GetFoldersGetSharedLinkByFolderId)

- [List items in folder](#GetFoldersItemsByFolderId)

- [List metadata instances on folder](#GetFoldersMetadataByFolderId)

- [Get metadata instance on folder](#GetFoldersMetadataByFolderIdScopeTemplateKey)

- [Get classification on folder](#GetFoldersMetadataEnterpriseSecurityClassification6vmvochwUwoByFolderId)

- [Get trashed folder](#GetFoldersTrashByFolderId)

- [List trashed items](#GetFoldersTrashItems)

- [Get watermark for folder](#GetFoldersWatermarkByFolderId)

- [Get group membership](#GetGroupMembershipsByGroupMembershipId)

- [List groups for enterprise](#GetGroups)

- [Get group](#GetGroupsByGroupId)

- [List collaborations for group](#GetGroupsCollaborationsByGroupId)

- [List members of group](#GetGroupsMembershipsByGroupId)

- [Get user invite status](#GetInvitesByInviteId)

- [List all legal hold policies](#GetLegalHoldPolicies)

- [Get legal hold policy](#GetLegalHoldPoliciesByLegalHoldPolicyId)

- [List legal hold policy assignments](#GetLegalHoldPolicyAssignments)

- [Get legal hold policy assignment](#GetLegalHoldPolicyAssignmentsByLegalHoldPolicyAssignmentId)

- [List previous file versions for legal hold policy assignment](#GetLegalHoldPolicyAssignmentsFileVersionsOnHoldByLegalHoldPolicyAssignmentId)

- [List current file versions for legal hold policy assignment](#GetLegalHoldPolicyAssignmentsFilesOnHoldByLegalHoldPolicyAssignmentId)

- [List metadata cascade policies](#GetMetadataCascadePolicies)

- [Get metadata cascade policy](#GetMetadataCascadePoliciesByMetadataCascadePolicyId)

- [Find metadata template by instance ID](#GetMetadataTemplates)

- [Get metadata template by ID](#GetMetadataTemplatesByTemplateId)

- [List all metadata templates for enterprise](#GetMetadataTemplatesEnterprise)

- [List all classifications](#GetMetadataTemplatesEnterpriseSecurityClassification6vmvochwUwoSchema)

- [List all global metadata templates](#GetMetadataTemplatesGlobal)

- [Get metadata template by name](#GetMetadataTemplatesSchemaByScopeTemplateKey)

- [Get events long poll endpoint](#GetOptionsEvents)

- [Preflight check before upload](#GetOptionsFilesContent)

- [List recently accessed items](#GetRecentItems)

- [List retention policies](#GetRetentionPolicies)

- [List retention policy assignments](#GetRetentionPoliciesAssignmentsByRetentionPolicyId)

- [Get retention policy](#GetRetentionPoliciesByRetentionPolicyId)

- [Get retention policy assignment](#GetRetentionPolicyAssignmentsByRetentionPolicyAssignmentId)

- [Search for content](#GetSearch)

- [Find file for shared link](#GetSharedItems)

- [Find folder for shared link](#GetSharedItemsfolders)

- [List storage policies](#GetStoragePolicies)

- [Get storage policy](#GetStoragePoliciesByStoragePolicyId)

- [List storage policy assignments](#GetStoragePolicyAssignments)

- [Get storage policy assignment](#GetStoragePolicyAssignmentsByStoragePolicyAssignmentId)

- [Get task assignment](#GetTaskAssignmentsByTaskAssignmentId)

- [List task assignments](#GetTasksAssignmentsByTaskId)

- [Get task](#GetTasksByTaskId)

- [List terms of service user statuses](#GetTermsOfServiceUserStatuses)

- [List terms of services](#GetTermsOfServices)

- [Get terms of service](#GetTermsOfServicesByTermsOfServiceId)

- [List enterprise users](#GetUsers)

- [Get user avatar](#GetUsersAvatarByUserId)

- [Get user](#GetUsersByUserId)

- [List user’s email aliases](#GetUsersEmailAliasesByUserId)

- [Get current user](#GetUsersMe)

- [List user’s groups](#GetUsersMembershipsByUserId)

- [Get web link](#GetWebLinksByWebLinkId)

- [Get trashed web link](#GetWebLinksTrashByWebLinkId)

- [List all webhooks](#GetWebhooks)

- [Get webhook](#GetWebhooksByWebhookId)

- [Download zip archive](#GetZipDownloadsContentByZipDownloadId)

- [Get zip download status](#GetZipDownloadsStatusByZipDownloadId)

- [Unauthorize](#Unauthorize)

- [PUpdate collaboration](#UpdateCollaborationsByCollaborationId)

- [Update comment](#UpdateCommentsByCommentId)

- [Update file request](#UpdateFileRequestsByFileRequestId)

- [Add shared link to file](#UpdateFilesAddSharedLinkByFileId)

- [Update file](#UpdateFilesByFileId)

- [Update metadata instance on file](#UpdateFilesMetadataByFileIdScopeTemplateKey)

- [Update classification on file](#UpdateFilesMetadataEnterpriseSecurityClassification6vmvochwUwoByFileId)

- [Update Box Skill cards on file](#UpdateFilesMetadataGlobalBoxSkillsCardsByFileId)

- [Remove shared link from file](#UpdateFilesRemoveSharedLinkByFileId)

- [Update shared link on file](#UpdateFilesUpdateSharedLinkByFileId)

- [Upload part of file](#UpdateFilesUploadSessionsByUploadSessionId)

- [Apply watermark to file](#UpdateFilesWatermarkByFileId)

- [Add shared link to folder](#UpdateFoldersAddSharedLinkByFolderId)

- [Update folder](#UpdateFoldersByFolderId)

- [Update metadata instance on folder](#UpdateFoldersMetadataByFolderIdScopeTemplateKey)

- [Update classification on folder](#UpdateFoldersMetadataEnterpriseSecurityClassification6VMVochwUWoByFolderId)

- [Remove shared link from folder](#UpdateFoldersRemoveSharedLinkByFolderId)

- [Update shared link on folder](#UpdateFoldersUpdateSharedLinkByFolderId)

- [Apply watermark to folder](#UpdateFoldersWatermarkByFolderId)

- [Update group membership](#UpdateGroupMembershipsByGroupMembershipId)

- [Update group](#UpdateGroupsByGroupId)

- [Update legal hold policy](#UpdateLegalHoldPoliciesByLegalHoldPolicyId)

- [Add classification](#UpdateMetadataTemplatesEnterpriseSecurityClassification6vmvochwUwoSchemaadd)

- [Delete classification](#UpdateMetadataTemplatesEnterpriseSecurityClassification6VMVochwUWoSchemadelete)

- [Update classification](#UpdateMetadataTemplatesEnterpriseSecurityClassification6vmvochwUwoSchemaupdate)

- [Update metadata template](#UpdateMetadataTemplatesSchemaByScopeTemplateKey)

- [Update retention policy](#UpdateRetentionPoliciesByRetentionPolicyId)

- [Update all Box Skill cards on file](#UpdateSkillInvocationsBySkillId)

- [Update storage policy assignment](#UpdateStoragePolicyAssignmentsByStoragePolicyAssignmentId)

- [Update task assignment](#UpdateTaskAssignmentsByTaskAssignmentId)

- [Update task](#UpdateTasksByTaskId)

- [Update terms of service status for existing user](#UpdateTermsOfServiceUserStatusesByTermsOfServiceUserStatusId)

- [Update terms of service](#UpdateTermsOfServicesByTermsOfServiceId)

- [Update user](#UpdateUsersByUserId)

- [Transfer owned folders](#UpdateUsersFolders0ByUserId)

- [Update web link](#UpdateWebLinksByWebLinkId)

- [Update webhook](#UpdateWebhooksByWebhookId)

## Associated Sources

- [On Download File Trigger](#OnDownloadFileListener)

- [On New File in Folder](#OnNewFileInFolderListener)

- [On New Folder](#OnNewFolderListener)

- [On New Task Created](#OnNewTaskCreatedListener)

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create user exemption from collaboration domain restrictions

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create collaboration

`<box:create-collaborations>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>notify</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Determines if users should receive email notification for the action performed.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create comment

`<box:create-comments>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Copy file request

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File request id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/filerequest/123">https://*.app.box.com/filerequest/123</a></code> the <code>file_request_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>String</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Timeout for the request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Restore file

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Upload file

`<box:create-files-content>`

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

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Content md5</p></td><td><div><div><p>String</p></div></div></td><td><p>An optional header containing the SHA1 hash of the file to ensure that the file was not corrupted in transit.</p></td><td></td><td></td></tr><tr><td><p>Attributes - Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>The content of the 'attributes' part.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>File - Body</p></td><td><div><div><p>String</p></div></div></td><td><p>The content of the 'file' part.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>file Filename</p></td><td><div><div><p>String</p></div></div></td><td><p>The filename of the 'file' part (just the name, do not include path).</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Upload file version

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

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

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>If match</p></td><td><div><div><p>String</p></div></div></td><td><p>Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed <code>etag</code> value into this header and the endpoint will fail with a <code>412 Precondition Failed</code> if it has changed since.</p></td><td></td><td></td></tr><tr><td><p>Content md5</p></td><td><div><div><p>String</p></div></div></td><td><p>An optional header containing the SHA1 hash of the file to ensure that the file was not corrupted in transit.</p></td><td></td><td></td></tr><tr><td><p>Attributes - Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>The content of the 'attributes' part.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>File - Body</p></td><td><div><div><p>String</p></div></div></td><td><p>The content of the 'file' part.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>file Filename</p></td><td><div><div><p>String</p></div></div></td><td><p>The filename of the 'file' part. Do not include the path; use only the file name.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Copy file

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create metadata instance on file

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

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

This operation makes an HTTP POST request to the /files/{file\_id}/metadata/{scope}/{template\_key}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>scope</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>GLOBAL</p></li><li><p>ENTERPRISE</p></li></ul></div></div></td><td><p>The scope of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Template key</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Add classification to file

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

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create Box Skill cards on file

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create upload session

`<box:create-files-upload-sessions>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create upload session for existing file

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for requests to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Commit upload session

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Upload session id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the upload session.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>digest</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>sha=BASE64_ENCODED_DIGEST</code>. [1]: <a href="https://datatracker.ietf.org/doc/html/rfc3230">https://datatracker.ietf.org/doc/html/rfc3230</a></p></td><td></td><td><p>X</p></td></tr><tr><td><p>If match</p></td><td><div><div><p>String</p></div></div></td><td><p>Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed <code>etag</code> value into this header and the endpoint will fail with a <code>412 Precondition Failed</code> if it has changed since.</p></td><td></td><td></td></tr><tr><td><p>If none match</p></td><td><div><div><p>String</p></div></div></td><td><p>Ensures an item is only returned if it has changed. Pass in the item’s last observed <code>etag</code> value into this header and the endpoint will fail with a <code>304 Not Modified</code> if the item has not changed since.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for requests to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Revert file version

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

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create folder lock on folder

`<box:create-folder-locks>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create folder

`<box:create-folders>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Restore folder

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

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

**Folder locking**

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

This operation makes an HTTP POST request to the /folders/{folder\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Copy folder

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder with the ID <code>0</code> can not be copied.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create metadata instance on folder

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

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

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

This operation makes an HTTP POST request to the
/folders/{folder\_id}/metadata/{scope}/{template\_key} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>scope</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>GLOBAL</p></li><li><p>ENTERPRISE</p></li></ul></div></div></td><td><p>The scope of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Template key</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Add classification to folder

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

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Add user to group

`<box:create-group-memberships>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create group

`<box:create-groups>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create user invite

`<box:create-invites>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create legal hold policy

`<box:create-legal-hold-policies>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Assign legal hold policy

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create metadata cascade policy

`<box:create-metadata-cascade-policies>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Force-apply metadata cascade policy to folder

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

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

This operation makes an HTTP POST request to the
/metadata\_cascade\_policies/{metadata\_cascade\_policy\_id}/apply endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Metadata cascade policy id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the cascade policy to force-apply.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Query files and folders by metadata

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create metadata template

`<box:create-metadata-templates-schema>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Add initial classifications

`<box:create-metadata-templates-schemaclassifications>`

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

This operation makes an HTTP POST request to the /metadata\_templates/schema#classifications
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create retention policy

`<box:create-retention-policies>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Assign retention policy

`<box:create-retention-policy-assignments>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Assign storage policy

`<box:create-storage-policy-assignments>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Assign task

`<box:create-task-assignments>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create task

`<box:create-tasks>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create terms of service status for new user

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

Sets the status for a terms of service for a user. This operation makes an HTTP POST request to the
/terms\_of\_service\_user\_statuses endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create terms of service

`<box:create-terms-of-services>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create user

`<box:create-users>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create email alias

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>User id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the user.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Restore web link

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

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

This operation makes an HTTP POST request to the /web\_links/{web\_link\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Web link id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the web link.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create webhook

`<box:create-webhooks>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Create zip download

`<box:create-zip-downloads>`

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

This operation makes an HTTP POST request to the /zip\_downloads endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove domain from list of allowed collaboration domains

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Collaboration whitelist entry id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the entry in the list.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove user from list of users exempt from domain restrictions

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

Removes a user’s exemption from the restrictions set out by the allowed list of domains for
collaborations. This operation makes an HTTP DELETE request to the
/collaboration\_whitelist\_exempt\_targets/{collaboration\_whitelist\_exempt\_target\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Collaboration whitelist exempt target id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the exemption to the list.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove collaboration

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Collaboration id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the collaboration</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove comment

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Comment id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the comment.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove device pin

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

Deletes an individual device pin. This operation makes an HTTP DELETE request to the
/device\_pinners/{device\_pinner\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Device pinner id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the device pin</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Delete file request

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

Deletes a file request permanently. This operation makes an HTTP DELETE request to the
/file\_requests/{file\_request\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File request id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/filerequest/123">https://*.app.box.com/filerequest/123</a></code> the <code>file_request_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Delete file

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

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

This operation makes an HTTP DELETE request to the /files/{file\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>If match</p></td><td><div><div><p>String</p></div></div></td><td><p>Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed <code>etag</code> value into this header and the endpoint will fail with a <code>412 Precondition Failed</code> if it has changed since.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove metadata instance from file

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

Deletes a piece of file metadata. This operation makes an HTTP DELETE request to the
/files/{file\_id}/metadata/{scope}/{template\_key} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>scope</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>GLOBAL</p></li><li><p>ENTERPRISE</p></li></ul></div></div></td><td><p>The scope of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Template key</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove classification from file

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

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove Box Skill cards from file

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Permanently remove file

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove upload session

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Upload session id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the upload session.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove file version

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File version id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the file version</p></td><td></td><td><p>X</p></td></tr><tr><td><p>If match</p></td><td><div><div><p>String</p></div></div></td><td><p>Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed <code>etag</code> value into this header and the endpoint will fail with a <code>412 Precondition Failed</code> if it has changed since.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove watermark from file

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Delete folder lock

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

Deletes a folder lock on a given folder. This operation makes an HTTP DELETE request to the
/folder\_locks/{folder\_lock\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder lock id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the folder lock.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Delete folder

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>recursive</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Delete a folder that is not empty by recursively deleting the folder and all of its content.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>If match</p></td><td><div><div><p>String</p></div></div></td><td><p>Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed <code>etag</code> value into this header and the endpoint will fail with a <code>412 Precondition Failed</code> if it has changed since.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove metadata instance from folder

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

Deletes a piece of folder metadata. This operation makes an HTTP DELETE request to the
/folders/{folder\_id}/metadata/{scope}/{template\_key} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>scope</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>GLOBAL</p></li><li><p>ENTERPRISE</p></li></ul></div></div></td><td><p>The scope of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Template key</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove classification from folder

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

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Permanently remove folder

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove watermark from folder

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove user from group

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Group membership id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the group membership.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove group

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Group id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the group.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove legal hold policy

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Legal hold policy id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the legal hold policy</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Unassign legal hold policy

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Legal hold policy assignment id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the legal hold policy assignment</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove metadata cascade policy

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

Deletes a metadata cascade policy. This operation makes an HTTP DELETE request to the
/metadata\_cascade\_policies/{metadata\_cascade\_policy\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Metadata cascade policy id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the metadata cascade policy.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Delete all classifications

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove metadata template

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>scope</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>GLOBAL</p></li><li><p>ENTERPRISE</p></li></ul></div></div></td><td><p>The scope of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Template key</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Unassign storage policy

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Storage policy assignment id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the storage policy assignment.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Unassign task

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

Deletes a specific task assignment. This operation makes an HTTP DELETE request to the
/task\_assignments/{task\_assignment\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Task assignment id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the task assignment.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove task

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Task id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the task.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Delete user

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>User id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the user.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>notify</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether the user will receive email notification of the deletion</p></td><td><p>false</p></td><td></td></tr><tr><td><p>force</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether the user should be deleted even if this user still own files</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove email alias

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

Removes an email alias from a user. This operation makes an HTTP DELETE request to the
/users/{user\_id}/email\_aliases/{email\_alias\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>User id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the user.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Email alias id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the email alias.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove web link

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

Deletes a web link. This operation makes an HTTP DELETE request to the /web\_links/{web\_link\_id}
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Web link id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the web link.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Permanently remove web link

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Web link id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the web link.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove webhook

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Webhook id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the webhook.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List allowed collaboration domains

`<box:get-collaboration-whitelist-entries>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get allowed collaboration domain

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

Returns a domain that has been deemed safe to create collaborations for within the current
enterprise. This operation makes an HTTP GET request to the
/collaboration\_whitelist\_entries/{collaboration\_whitelist\_entry\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Collaboration whitelist entry id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the entry in the list.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List users exempt from collaboration domain restrictions

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get user exempt from collaboration domain restrictions

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

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

This operation makes an HTTP GET request to the
/collaboration\_whitelist\_exempt\_targets/{collaboration\_whitelist\_exempt\_target\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Collaboration whitelist exempt target id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the exemption to the list.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List pending collaborations

`<box:get-collaborations>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>status</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PENDING</p></li></ul></div></div></td><td><p>The status of the collaborations to retrieve</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>The offset of the item at which to begin the response.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get collaboration

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Collaboration id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the collaboration</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List all collections

`<box:get-collections>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>The offset of the item at which to begin the response.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List collection items

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Collection id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the collection.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>The offset of the item at which to begin the response.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any * Any * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get comment

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Comment id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the comment.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get device pin

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

Retrieves information about an individual device pin. This operation makes an HTTP GET request to
the /device\_pinners/{device\_pinner\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Device pinner id</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the device pin</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List enterprise device pins

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

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Enterprise id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the enterprise</p></td><td></td><td><p>X</p></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>direction</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ASC</p></li><li><p>DESC</p></li></ul></div></div></td><td><p>The direction to sort results in. This can be either in alphabetical ascending (<code>ASC</code>) or descending (<code>DESC</code>) order.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List user and enterprise events

`<box:get-events>`

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

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Stream type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALL</p></li><li><p>CHANGES</p></li><li><p>SYNC</p></li><li><p>ADMIN_LOGS</p></li></ul></div></div></td><td><p>Defines the type of events that are returned * <code>all</code> returns everything for a user and is the default * <code>changes</code> returns events that may cause file tree changes such as file updates or collaborations. * <code>sync</code> is similar to <code>changes</code> but only applies to synced folders * <code>admin_logs</code> returns all events for an entire enterprise and requires the user making the API call to have admin permissions.</p></td><td><p>ALL</p></td><td></td></tr><tr><td><p>Stream position</p></td><td><div><div><p>String</p></div></div></td><td><p>The location in the event stream to start receiving events from. * <code>now</code> will return an empty list events and the latest stream position for initialization. * <code>0</code> or <code>null</code> will return all events.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Limits the number of events returned</p></td><td><p>100</p></td><td></td></tr><tr><td><p>Event type</p></td><td><div><div><p>Array of Enumeration, one of:</p></div><div><ul><li><p>ACCESS_GRANTED</p></li><li><p>ACCESS_REVOKED</p></li><li><p>ADD_DEVICE_ASSOCIATION</p></li><li><p>ADD_LOGIN_ACTIVITY_DEVICE</p></li><li><p>ADMIN_LOGIN</p></li><li><p>APPLICATION_CREATED</p></li><li><p>APPLICATION_PUBLIC_KEY_ADDED</p></li><li><p>APPLICATION_PUBLIC_KEY_DELETED</p></li><li><p>CHANGE_ADMIN_ROLE</p></li><li><p>CHANGE_FOLDER_PERMISSION</p></li><li><p>COLLABORATION_ACCEPT</p></li><li><p>COLLABORATION_EXPIRATION</p></li><li><p>COLLABORATION_INVITE</p></li><li><p>COLLABORATION_REMOVE</p></li><li><p>COLLABORATION_ROLE_CHANGE</p></li><li><p>COMMENT_CREATE</p></li><li><p>COMMENT_DELETE</p></li><li><p>CONTENT_WORKFLOW_ABNORMAL_DOWNLOAD_ACTIVITY</p></li><li><p>CONTENT_WORKFLOW_AUTOMATION_ADD</p></li><li><p>CONTENT_WORKFLOW_AUTOMATION_DELETE</p></li><li><p>CONTENT_WORKFLOW_POLICY_ADD</p></li><li><p>CONTENT_WORKFLOW_SHARING_POLICY_VIOLATION</p></li><li><p>CONTENT_WORKFLOW_UPLOAD_POLICY_VIOLATION</p></li><li><p>COPY</p></li><li><p>DATA_RETENTION_CREATE_RETENTION</p></li><li><p>DATA_RETENTION_REMOVE_RETENTION</p></li><li><p>DELETE</p></li><li><p>DELETE_USER</p></li><li><p>DEVICE_TRUST_CHECK_FAILED</p></li><li><p>DOWNLOAD</p></li><li><p>EDIT</p></li><li><p>EDIT_USER</p></li><li><p>EMAIL_ALIAS_CONFIRM</p></li><li><p>EMAIL_ALIAS_REMOVE</p></li><li><p>ENTERPRISE_APP_AUTHORIZATION_UPDATE</p></li><li><p>EXTERNAL_COLLAB_SECURITY_SETTINGS</p></li><li><p>FAILED_LOGIN</p></li><li><p>FILE_MARKED_MALICIOUS</p></li><li><p>FILE_WATERMARKED_DOWNLOAD</p></li><li><p>GROUP_ADD_ITEM</p></li><li><p>GROUP_ADD_USER</p></li><li><p>GROUP_CREATION</p></li><li><p>GROUP_DELETION</p></li><li><p>GROUP_EDITED</p></li><li><p>GROUP_REMOVE_ITEM</p></li><li><p>GROUP_REMOVE_USER</p></li><li><p>ITEM_MODIFY</p></li><li><p>ITEM_OPEN</p></li><li><p>ITEM_SHARED_UPDATE</p></li><li><p>ITEM_SYNC</p></li><li><p>ITEM_UNSYNC</p></li><li><p>LEGAL_HOLD_ASSIGNMENT_CREATE</p></li><li><p>LEGAL_HOLD_ASSIGNMENT_DELETE</p></li><li><p>LEGAL_HOLD_POLICY_CREATE</p></li><li><p>LEGAL_HOLD_POLICY_DELETE</p></li><li><p>LEGAL_HOLD_POLICY_UPDATE</p></li><li><p>LOCK</p></li><li><p>LOGIN</p></li><li><p>METADATA_INSTANCE_CREATE</p></li><li><p>METADATA_INSTANCE_DELETE</p></li><li><p>METADATA_INSTANCE_UPDATE</p></li><li><p>METADATA_TEMPLATE_CREATE</p></li><li><p>METADATA_TEMPLATE_DELETE</p></li><li><p>METADATA_TEMPLATE_UPDATE</p></li><li><p>MOVE</p></li><li><p>NEW_USER</p></li><li><p>OAUTH2_ACCESS_TOKEN_REVOKE</p></li><li><p>PREVIEW</p></li><li><p>REMOVE_DEVICE_ASSOCIATION</p></li><li><p>REMOVE_LOGIN_ACTIVITY_DEVICE</p></li><li><p>RENAME</p></li><li><p>RETENTION_POLICY_ASSIGNMENT_ADD</p></li><li><p>SHARE</p></li><li><p>SHARE_EXPIRATION</p></li><li><p>SHIELD_ALERT</p></li><li><p>STORAGE_EXPIRATION</p></li><li><p>TASK_ASSIGNMENT_CREATE</p></li><li><p>TASK_ASSIGNMENT_DELETE</p></li><li><p>TASK_ASSIGNMENT_UPDATE</p></li><li><p>TASK_CREATE</p></li><li><p>TASK_UPDATE</p></li><li><p>TERMS_OF_SERVICE_ACCEPT</p></li><li><p>TERMS_OF_SERVICE_REJECT</p></li><li><p>UNDELETE</p></li><li><p>UNLOCK</p></li><li><p>UNSHARE</p></li><li><p>UPDATE_COLLABORATION_EXPIRATION</p></li><li><p>UPDATE_SHARE_EXPIRATION</p></li><li><p>UPLOAD</p></li><li><p>USER_AUTHENTICATE_OAUTH2_ACCESS_TOKEN_CREATE</p></li><li><p>WATERMARK_LABEL_CREATE</p></li><li><p>WATERMARK_LABEL_DELETE</p></li></ul></div></div></td><td><p>A comma-separated list of events to filter by. This can only be used when requesting the events with a <code>stream_type</code> of <code>admin_logs</code>. For any other <code>stream_type</code> this value will be ignored.</p></td><td></td><td></td></tr><tr><td><p>Created after</p></td><td><div><div><p>String</p></div></div></td><td><p>The lower bound date and time to return events for. This can only be used when requesting the events with a <code>stream_type</code> of <code>admin_logs</code>. For any other <code>stream_type</code> this value will be ignored.</p></td><td></td><td></td></tr><tr><td><p>Created before</p></td><td><div><div><p>String</p></div></div></td><td><p>The upper bound date and time to return events for. This can only be used when requesting the events with a <code>stream_type</code> of <code>admin_logs</code>. For any other <code>stream_type</code> this value will be ignored.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get file request

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

Retrieves the information about a file request. This operation makes an HTTP GET request to the
/file\_requests/{file\_request\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File request id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/filerequest/123">https://*.app.box.com/filerequest/123</a></code> the <code>file_request_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List file version legal holds

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

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

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

This operation makes an HTTP GET request to the /file\_version\_legal\_holds endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Policy id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the legal hold policy to get the file version legal holds for.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get file version legal hold

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

Retrieves information about the legal hold policies assigned to a file version. This operation makes
an HTTP GET request to the /file\_version\_legal\_holds/{file\_version\_legal\_hold\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File version legal hold id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the file version legal hold</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List file version retentions

`<box:get-file-version-retentions>`

Retrieves all file version retentions for the given enterprise. This operation makes an HTTP GET
request to the /file\_version\_retentions endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>Filters results by files with this ID.</p></td><td></td><td></td></tr><tr><td><p>File version id</p></td><td><div><div><p>String</p></div></div></td><td><p>Filters results by file versions with this ID.</p></td><td></td><td></td></tr><tr><td><p>Policy id</p></td><td><div><div><p>String</p></div></div></td><td><p>Filters results by the retention policy with this ID.</p></td><td></td><td></td></tr><tr><td><p>Disposition action</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PERMANENTLY_DELETE</p></li><li><p>REMOVE_RETENTION</p></li></ul></div></div></td><td><p>Filters results by the retention policy with this disposition action.</p></td><td></td><td></td></tr><tr><td><p>Disposition before</p></td><td><div><div><p>String</p></div></div></td><td><p>Filters results by files that will have their disposition come into effect before this date.</p></td><td></td><td></td></tr><tr><td><p>Disposition after</p></td><td><div><div><p>String</p></div></div></td><td><p>Filters results by files that will have their disposition come into effect after this date.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get retention on file

`<box:get-file-version-retentions-by-file-version-retention-id>`

Returns information about a file version retention. This operation makes an HTTP GET request to the
/file\_version\_retentions/{file\_version\_retention\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File version retention id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the file version retention</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get file information

`<box:get-files-by-file-id>`

Retrieves the details about a file. This operation makes an HTTP GET request to the
/files/{file\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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 <code>metadata</code> field as well as the scope and key of the template to retrieve, for example <code>?field=metadata.enterprise_12345.contractTemplate</code>.</p></td><td></td><td></td></tr><tr><td><p>If none match</p></td><td><div><div><p>String</p></div></div></td><td><p>Ensures an item is returned only if it has changed. Pass in the item’s last observed <code>etag</code> value into this header and the endpoint will fail with a <code>304 Not Modified</code> if the item has not changed since.</p></td><td></td><td></td></tr><tr><td><p>boxapi</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>shared_link=[link]</code> or if a password is required then use <code>shared_link=[link]&amp;shared_link_password=[password]</code>. This header can be used on the file or folder shared, as well as on any files or folders nested within the item.</p></td><td></td><td></td></tr><tr><td><p>X rep hints</p></td><td><div><div><p>String</p></div></div></td><td><p>A header required to request specific <code>representations</code> of a file. Use this in combination with the <code>fields</code> query parameter to request a specific file representation. The general format for these representations is <code>X-Rep-Hints: […​]</code> where <code>[…​]</code> is one or many hints in the format <code>[fileType?query]</code>. For example, to request a <code>png</code> representation in <code>32x32</code> as well as <code>94x94</code> pixel dimensions provide the following hints. <code>X-Rep-Hints: [jpg?dimensions=32x32][jpg?dimensions=94x94]</code> Additionally, a <code>text</code> representation is available for all document file types in Box using the <code>[extracted_text]</code> representation. <code>X-Rep-Hints: [extracted_text]</code></p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List file collaborations

`<box:get-files-collaborations-by-file-id>`

Retrieves a list of pending and active collaborations for a file. This returns all the users that
have access to the file or have been invited to the file. This operation makes an HTTP GET request
to the /files/{file\_id}/collaborations endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List file comments

`<box:get-files-comments-by-file-id>`

Retrieves a list of comments for a file. This operation makes an HTTP GET request to the
/files/{file\_id}/comments endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>The offset of the item at which to begin the response.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Download file

`<box:get-files-content-by-file-id>`

Returns the contents of a file in binary format. This operation makes an HTTP GET request to the
/files/{file\_id}/content endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>version</p></td><td><div><div><p>String</p></div></div></td><td><p>The file version to download</p></td><td></td><td></td></tr><tr><td><p>Access token</p></td><td><div><div><p>String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>range</p></td><td><div><div><p>String</p></div></div></td><td><p>The byte range of the content to download. The format <code>{start_byte}-{end_byte}</code> can be used to specify what section of the file to download.</p></td><td></td><td></td></tr><tr><td><p>boxapi</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>shared_link=[link]</code> or if a password is required then use <code>shared_link=[link]&amp;shared_link_password=[password]</code>. This header can be used on the file or folder shared, as well as on any files or folders nested within the item.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get shared link for file

`<box:get-files-get-shared-link-by-file-id>`

Gets the information for a shared link on a file. This operation makes an HTTP GET request to the
/files/{file\_id}#get\_shared\_link endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Explicitly request the <code>shared_link</code> fields to be returned for this item.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List metadata instances on file

`<box:get-files-metadata-by-file-id>`

Retrieves all metadata for a given file. This operation makes an HTTP GET request to the
/files/{file\_id}/metadata endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get metadata instance on file

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

Retrieves the instance of a metadata template that has been applied to a file. This operation makes
an HTTP GET request to the /files/{file\_id}/metadata/{scope}/{template\_key} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>scope</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>GLOBAL</p></li><li><p>ENTERPRISE</p></li></ul></div></div></td><td><p>The scope of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Template key</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get classification on file

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

Retrieves the classification metadata instance that has been applied to a file. This API can also be
called by including the enterprise ID in the URL explicitly, for example
`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`. This operation makes an HTTP GET
request to the /files/{file\_id}/metadata/enterprise/securityClassification-6VMVochwUWo endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List Box Skill cards on file

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

List the Box Skills metadata cards that are attached to a file. This operation makes an HTTP GET
request to the /files/{file\_id}/metadata/global/boxSkillsCards endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List tasks on file

`<box:get-files-tasks-by-file-id>`

Retrieves a list of all the tasks for a file. This endpoint does not support pagination. This
operation makes an HTTP GET request to the /files/{file\_id}/tasks endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get file thumbnail

`<box:get-files-thumbnail-by-file-id-extension>`

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

This operation makes an HTTP GET request to the /files/{file\_id}/thumbnail.{extension} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>extension</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PNG</p></li><li><p>JPG</p></li></ul></div></div></td><td><p>The file format for the thumbnail</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Min height</p></td><td><div><div><p>Number</p></div></div></td><td><p>The minimum height of the thumbnail</p></td><td></td><td></td></tr><tr><td><p>Min width</p></td><td><div><div><p>Number</p></div></div></td><td><p>The minimum width of the thumbnail</p></td><td></td><td></td></tr><tr><td><p>Max height</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum height of the thumbnail</p></td><td></td><td></td></tr><tr><td><p>Max width</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum width of the thumbnail</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get trashed file

`<box:get-files-trash-by-file-id>`

Retrieves a file that has been moved to the trash. The file can only be retrieved only if the file
itself has been moved to the trash. If instead one of its parent folders was moved to the trash,
only that folder can be inspected using the
\[`GET /folders/:id/trash`\](e://get\_folders\_id\_trash) API. To list all items that have been
moved to the trash, use the \[`GET /folders/trash/items`\](e://get-folders-trash-items/) API.

This operation makes an HTTP GET request to the /files/{file\_id}/trash endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get upload session

`<box:get-files-upload-sessions-by-upload-session-id>`

Returns information about an upload session. This operation makes an HTTP GET request to the
/files/upload\_sessions/{upload\_session\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Upload session id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the upload session.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List parts

`<box:get-files-upload-sessions-parts-by-upload-session-id>`

Returns a list of the chunks uploaded to the upload session so far. This operation makes an HTTP GET
request to the /files/upload\_sessions/{upload\_session\_id}/parts endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Upload session id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the upload session.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>The offset of the item at which to begin the response.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List all file versions

`<box:get-files-versions-by-file-id>`

Retrieves a list of the past versions for a file. Versions are only tracked by Box users with
premium accounts. To fetch the ID of the current version of a file, use the `GET /file/:id` API.
This operation makes an HTTP GET request to the /files/{file\_id}/versions endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>The offset of the item at which to begin the response.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get file version

`<box:get-files-versions-by-file-id-file-version-id>`

Retrieves a specific version of a file. Versions are only tracked for Box users with premium
accounts. This operation makes an HTTP GET request to the
/files/{file\_id}/versions/{file\_version\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File version id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the file version</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get watermark on file

`<box:get-files-watermark-by-file-id>`

Retrieves the watermark for a file. This operation makes an HTTP GET request to the
/files/{file\_id}/watermark endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List folder locks on folder

`<box:get-folder-locks>`

Retrieves folder lock details for a given folder. This operation makes an HTTP GET request to the
/folder\_locks endpoint

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get folder information

`<box:get-folders-by-folder-id>`

Retrieves details for a folder, including the first 100 entries in the folder. To fetch more items
within the folder, use the \[Get items in a folder\](#get-folders-id-items) endpoint. This operation
makes an HTTP GET request to the /folders/{folder\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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 <code>metadata</code> field as well as the scope and key of the template to retrieve, for example <code>?field=metadata.enterprise_12345.contractTemplate</code>.</p></td><td></td><td></td></tr><tr><td><p>If none match</p></td><td><div><div><p>String</p></div></div></td><td><p>Ensures an item is only returned if it has changed. Pass in the item’s last observed <code>etag</code> value into this header and the endpoint will fail with a <code>304 Not Modified</code> if the item has not changed since.</p></td><td></td><td></td></tr><tr><td><p>boxapi</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>shared_link=[link]</code> or if a password is required then use <code>shared_link=[link]&amp;shared_link_password=[password]</code>. This header can be used on the file or folder shared, as well as on any files or folders nested within the item.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List folder collaborations

`<box:get-folders-collaborations-by-folder-id>`

Retrieves a list of pending and active collaborations for a folder. This returns all the users that
have access to the folder or have been invited to the folder. This operation makes an HTTP GET
request to the /folders/{folder\_id}/collaborations endpoint.

In Box Connector 5.2.2 and later, this operation no longer uses pagination since Box changed its
underlying API endpoint, so the **offset** and **limit** fields are now ignored but are present only
for backward compatibility.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>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.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get shared link for folder

`<box:get-folders-get-shared-link-by-folder-id>`

Gets the information for a shared link on a folder. This operation makes an HTTP GET request to the
/folders/{folder\_id}#get\_shared\_link endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Explicitly request the <code>shared_link</code> fields to be returned for this item.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List items in folder

`<box:get-folders-items-by-folder-id>`

Retrieves a page of items in a folder. These items can be files, folders, and web links. To request
more information about the folder itself, like its size, use the \[Get a folder\](#get-folders-id)
endpoint instead. This operation makes an HTTP GET request to the /folders/{folder\_id}/items
endpoint. The operation automatically paginates the results using offset pagination.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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 <code>metadata</code> field as well as the scope and key of the template to retrieve, for example <code>?field=metadata.enterprise_12345.contractTemplate</code>.</p></td><td></td><td></td></tr><tr><td><p>DO NOT USE - usemarker</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>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 <code>marker</code> field that can be passed as a parameter to this endpoint to get the next page of the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>DO NOT USE - marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>The offset of the item at which to begin the response.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>sort</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ID</p></li><li><p>NAME</p></li><li><p>DATE</p></li><li><p>SIZE</p></li></ul></div></div></td><td><p>Defines the <strong>second</strong> attribute by which items are sorted. Items are always sorted by their <code>type</code> first, with folders listed before files, and files listed before web links. This parameter is not supported for marker-based pagination on the root folder (the folder with an ID of <code>0</code>).</p></td><td></td><td></td></tr><tr><td><p>direction</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ASC</p></li><li><p>DESC</p></li></ul></div></div></td><td><p>The direction to sort results in. This can be either in alphabetical ascending (<code>ASC</code>) or descending (<code>DESC</code>) order.</p></td><td></td><td></td></tr><tr><td><p>boxapi</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>shared_link=[link]</code> or if a password is required then use <code>shared_link=[link]&amp;shared_link_password=[password]</code>. This header can be used on the file or folder shared, as well as on any files or folders nested within the item.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List metadata instances on folder

`<box:get-folders-metadata-by-folder-id>`

Retrieves all metadata for a given folder. This can not be used on the root folder with ID `0`. This
operation makes an HTTP GET request to the /folders/{folder\_id}/metadata endpoint

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get metadata instance on folder

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

Retrieves the instance of a metadata template that has been applied to a folder. This cannot be used
on the root folder with an ID of `0`. This operation makes an HTTP GET request to the
/folders/{folder\_id}/metadata/{scope}/{template\_key} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>scope</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>GLOBAL</p></li><li><p>ENTERPRISE</p></li></ul></div></div></td><td><p>The scope of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Template key</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get classification on folder

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

Retrieves the classification metadata instance that has been applied to a folder. This API can also
be called by including the enterprise ID in the URL explicitly, for example
`/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo`. This operation makes an HTTP
GET request to the /folders/{folder\_id}/metadata/enterprise/securityClassification-6VMVochwUWo
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get trashed folder

`<box:get-folders-trash-by-folder-id>`

Retrieves a folder that has been moved to the trash. If only the folder itself has been moved to the
trash, it can be retrieved with this API call. If instead, one of its parent folders was moved to
the trash, that folder can only be inspected using the
\[`GET /folders/:id/trash`\](e://get\_folders\_id\_trash) API. To list all items that have been
moved to the trash, use the \[`GET /folders/trash/items`\](e://get-folders-trash-items/) API. This
operation makes an HTTP GET request to the /folders/{folder\_id}/trash endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List trashed items

`<box:get-folders-trash-items>`

Retrieves the files and folders that have been moved to the trash. Any attribute in the full files
or folders objects can be passed in with the `fields` parameter to retrieve those specific
attributes that are not returned by default. This endpoint defaults to use offset-based pagination,
and also supports marker-based pagination using the `marker` parameter. This operation makes an HTTP
GET request to the /folders/trash/items endpoint. The operation automatically paginates the results
using offset pagination.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>The offset of the item at which to begin the response.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>DO NOT USE - usemarker</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>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 <code>marker</code> field that can be passed as a parameter to this endpoint to get the next page of the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>DO NOT USE - marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>direction</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ASC</p></li><li><p>DESC</p></li></ul></div></div></td><td><p>The direction to sort results in. This can be either in alphabetical ascending (<code>ASC</code>) or descending (<code>DESC</code>) order.</p></td><td></td><td></td></tr><tr><td><p>sort</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ID</p></li><li><p>NAME</p></li><li><p>DATE</p></li><li><p>SIZE</p></li></ul></div></div></td><td><p>Defines the <strong>second</strong> attribute by which items are sorted. Items are always sorted by their <code>type</code> first, with folders listed before files, and files listed before web links. This parameter is not supported when using marker-based pagination.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get watermark for folder

`<box:get-folders-watermark-by-folder-id>`

Retrieve the watermark for a folder. This operation makes an HTTP GET request to the
/folders/{folder\_id}/watermark endpoint

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get group membership

`<box:get-group-memberships-by-group-membership-id>`

Retrieves a specific group membership. Only admins of this group or users with admin-level
permissions will be able to use this API. This operation makes an HTTP GET request to the
/group\_memberships/{group\_membership\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Group membership id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the group membership.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List groups for enterprise

`<box:get-groups>`

Retrieves all of the groups for a given enterprise. The user must have admin permissions to inspect
enterprise’s groups. This operation makes an HTTP GET request to the /groups endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Filter term</p></td><td><div><div><p>String</p></div></div></td><td><p>Limits the results to only groups whose <code>name</code> starts with the search term.</p></td><td></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>The offset of the item at which to begin the response.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get group

`<box:get-groups-by-group-id>`

Retrieves information about a group. Only members of this group or users with admin-level
permissions will be able to use this API. This operation makes an HTTP GET request to the
/groups/{group\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Group id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the group.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List collaborations for group

`<box:get-groups-collaborations-by-group-id>`

Retrieves all the collaborations for a group. The user must have admin permissions to inspect
enterprise’s groups. Each collaboration object has details on which files or folders the group has
access to and with what role. This operation makes an HTTP GET request to the
/groups/{group\_id}/collaborations endpoint

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Group id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the group.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>The offset of the item at which to begin the response.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List members of group

`<box:get-groups-memberships-by-group-id>`

Retrieves all the members for a group. Only members of this group or users with admin-level
permissions will be able to use this API. This operation makes an HTTP GET request to the
/groups/{group\_id}/memberships endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Group id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the group.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>The offset of the item at which to begin the response.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get user invite status

`<box:get-invites-by-invite-id>`

Returns the status of a user invite. This operation makes an HTTP GET request to the
/invites/{invite\_id} endpoint

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Invite id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of an invite.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List all legal hold policies

`<box:get-legal-hold-policies>`

Retrieves a list of legal hold policies that belong to an enterprise. This operation makes an HTTP
GET request to the /legal\_hold\_policies endpoint

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Policy name</p></td><td><div><div><p>String</p></div></div></td><td><p>Limits results to policies for which the names start with this search term. This is a case-insensitive prefix.</p></td><td></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get legal hold policy

`<box:get-legal-hold-policies-by-legal-hold-policy-id>`

Retrieve a legal hold policy. This operation makes an HTTP GET request to the
/legal\_hold\_policies/{legal\_hold\_policy\_id} endpoint

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Legal hold policy id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the legal hold policy</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List legal hold policy assignments

`<box:get-legal-hold-policy-assignments>`

Retrieves a list of items a legal hold policy has been assigned to. This operation makes an HTTP GET
request to the /legal\_hold\_policy\_assignments endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Policy id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the legal hold policy</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Assign to type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>FILE</p></li><li><p>FILE_VERSION</p></li><li><p>FOLDER</p></li><li><p>USER</p></li></ul></div></div></td><td><p>Filters the results by the type of item the policy was applied to.</p></td><td></td><td></td></tr><tr><td><p>Assign to id</p></td><td><div><div><p>String</p></div></div></td><td><p>Filters the results by the ID of item the policy was applied to.</p></td><td></td><td></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get legal hold policy assignment

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

Retrieve a legal hold policy assignment. This operation makes an HTTP GET request to the
/legal\_hold\_policy\_assignments/{legal\_hold\_policy\_assignment\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Legal hold policy assignment id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the legal hold policy assignment</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List previous file versions for legal hold policy assignment

`<box:get-legal-hold-policy-assignments-file-versions-on-hold-by-legal-hold-policy-assignment-id>`

Get a list of previous file versions for a legal hold assignment. In some cases you may only need
the latest file versions instead. In these cases, use the
`GET /legal_hold_policy_assignments/:id/files_on_hold` API instead to return any current (latest)
versions of a file for this legal hold policy assignment. Due to ongoing re-architecture efforts
this API might not return all files held for this policy ID. Instead, this API will only return past
file versions held in the newly developed architecture. The `GET /file_version_legal_holds` API can
be used to fetch current and past versions of files held within the legacy architecture. The
`GET /legal_hold_policy_assignments?policy_id={id}` API can be used to find a list of policy
assignments for a given policy ID. This operation makes an HTTP GET request to the
/legal\_hold\_policy\_assignments/{legal\_hold\_policy\_assignment\_id}/file\_versions\_on\_hold
endpoint

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Legal hold policy assignment id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the legal hold policy assignment</p></td><td></td><td><p>X</p></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List current file versions for legal hold policy assignment

`<box:get-legal-hold-policy-assignments-files-on-hold-by-legal-hold-policy-assignment-id>`

Gets a list of current file versions for a legal hold assignment. In some cases you may want to get
previous file versions instead. In these cases, use the
`GET /legal_hold_policy_assignments/:id/file_versions_on_hold` API instead to return any previous
versions of a file for this legal hold policy assignment.

Due to ongoing rearchitecture efforts, this API might not return all file versions held for this
policy ID. Instead, this API will return only the latest file version held in the newly developed
architecture. The `GET /file_version_legal_holds` API can be used to fetch current and past versions
of files held within the legacy architecture. The
`GET /legal_hold_policy_assignments?policy_id={id}` API can be used to find a list of policy
assignments for a given policy ID.

This operation makes an HTTP GET request to the
/legal\_hold\_policy\_assignments/{legal\_hold\_policy\_assignment\_id}/files\_on\_hold endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Legal hold policy assignment id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the legal hold policy assignment</p></td><td></td><td><p>X</p></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List metadata cascade policies

`<box:get-metadata-cascade-policies>`

Retrieves a list of all the metadata cascade policies that are applied to a given folder. This can
not be used on the root folder with ID `0`. This operation makes an HTTP GET request to the
/metadata\_cascade\_policies endpoint

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies which folder to return policies for. This can not be used on the root folder with ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Owner enterprise id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the enterprise ID for which to find metadata cascade policies. If not specified, it defaults to the current enterprise.</p></td><td></td><td></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>The offset of the item at which to begin the response.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get metadata cascade policy

`<box:get-metadata-cascade-policies-by-metadata-cascade-policy-id>`

Retrieve a specific metadata cascade policy assigned to a folder. This operation makes an HTTP GET
request to the /metadata\_cascade\_policies/{metadata\_cascade\_policy\_id} endpoint

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Metadata cascade policy id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the metadata cascade policy.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Find metadata template by instance ID

`<box:get-metadata-templates>`

Finds a metadata template by searching for the ID of an instance of the template. This operation
makes an HTTP GET request to the /metadata\_templates endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Metadata instance id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of an instance of the metadata template to find.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get metadata template by ID

`<box:get-metadata-templates-by-template-id>`

Retrieves a metadata template by its ID. This operation makes an HTTP GET request to the
/metadata\_templates/{template\_id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Template id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List all 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List all 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List all 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get metadata template by 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>scope</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>GLOBAL</p></li><li><p>ENTERPRISE</p></li></ul></div></div></td><td><p>The scope of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Template key</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get 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:

1.  First, use this endpoint to retrieve a list of long poll URLs.

2.  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 known
    `stream_position`.

3.  After the server sends this response, it closes the connection.

4.  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 in `retry_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.

5.  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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Policy name</p></td><td><div><div><p>String</p></div></div></td><td><p>Filters results by a case sensitive prefix of the name of retention policies.</p></td><td></td><td></td></tr><tr><td><p>Policy type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>FINITE</p></li><li><p>INDEFINITE</p></li></ul></div></div></td><td><p>Filters results by the type of retention policy.</p></td><td></td><td></td></tr><tr><td><p>Created by user id</p></td><td><div><div><p>String</p></div></div></td><td><p>Filters results by the ID of the user who created policy.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Retention policy id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the retention policy.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>FOLDER</p></li><li><p>ENTERPRISE</p></li></ul></div></div></td><td><p>The type of the retention policy assignment to retrieve.</p></td><td></td><td></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get retention 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Retention policy id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the retention policy.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Retention policy assignment id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the retention policy assignment.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>query</p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div><div><p>This parameter supports a variety of operators to further refine the results returns.</p></div><div><ul><li><p><code>""</code> Wrapping a query in double quotes means only exact matches are returned by the API. Exact searches do not return search matches based on specific character sequences. Instead, they return matches based on phrases, that is, word sequences, for example: A search for <code>"Blue-Box"</code> may return search results including the sequence <code>"blue.box"</code>, <code>"Blue Box"</code>, and <code>"Blue-Box"</code>; any item containing the words <code>Blue</code> and <code>Box</code> consecutively, in the order specified.</p></li><li><p><code>AND</code> returns items that contain both the search terms. For example, a search for <code>marketing AND BoxWorks</code> returns items that have both <code>marketing</code> and <code>BoxWorks</code> within its text in any order. It does not return a result that only has <code>BoxWorks</code> in its text.</p></li><li><p><code>OR</code> returns items that contain either of the search terms. For example, a search for <code>marketing OR BoxWorks</code> returns a result that has either <code>marketing</code> or <code>BoxWorks</code> within its text. Using this operator is not necessary as we implicitly interpret multi-word queries as <code>OR</code> unless another supported boolean term is used.</p></li><li><p><code>NOT</code> returns items that do not contain the search term provided. For example, a search for <code>marketing AND NOT BoxWorks</code> returns a result that has only <code>marketing</code> within its text. Results containing <code>BoxWorks</code> are omitted.</p></li></ul></div><div><div data-type="NOTE">Lower case (that is, <code>and</code>, <code>or</code>, and <code>not</code>) or mixed case (that is, <code>And</code>, <code>Or</code>, and <code>Not</code>) operators are not supported.</div></div><div><div><pre>This field is required unless the `mdfilters` parameter is defined.</pre></div></div></div></td><td></td><td></td></tr><tr><td><p>scope</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>USER_CONTENT</p></li><li><p>ENTERPRISE_CONTENT</p></li></ul></div></div></td><td><p>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 <code>user_content</code>, which limits the search results to content that is available to the currently authenticated user. The <code>enterprise_content</code> can be requested by an admin through our support channels. Once this scope has been enabled for a user, it will allow that use to query for content across the entire enterprise and not only the content that they have access to.</p></td><td><p>USER_CONTENT</p></td><td></td></tr><tr><td><p>File extensions</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Created at range</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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 (<code>,2014-05-17T13:35:01-07:00</code>) anything created before the end date will be returned. If the end date is omitted (<code>2014-05-15T13:35:01-07:00,</code>) the current date will be used as the end date instead.</p></td><td></td><td></td></tr><tr><td><p>Updated at range</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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 (<code>,2014-05-17T13:35:01-07:00</code>) anything updated before the end date will be returned. If the end date is omitted (<code>2014-05-15T13:35:01-07:00,</code>) the current date will be used as the end date instead.</p></td><td></td><td></td></tr><tr><td><p>Size range</p></td><td><div><div><p>Array of Number</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Owner user ids</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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 <code>enterprise_content</code> scope parameter, which can be requested from the Box support team.</p></td><td></td><td></td></tr><tr><td><p>Ancestor folder ids</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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 <code>HTTP 404</code> error code will be returned instead. To search across an entire enterprise, use the <code>enterprise_content</code> scope parameter, which can be requested from the Box support team.</p></td><td></td><td></td></tr><tr><td><p>Content types</p></td><td><div><div><p>Array of Enumeration, one of:</p></div><div><ul><li><p>NAME</p></li><li><p>DESCRIPTION</p></li><li><p>FILE_CONTENT</p></li><li><p>COMMENTS</p></li><li><p>TAG</p></li></ul></div></div></td><td><div><div><p>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:</p></div><div><ul><li><p><code>name</code> - The name of the item, as defined by its <code>name</code> field.</p></li><li><p><code>description</code> - The description of the item, as defined by its <code>description</code> field.</p></li><li><p><code>file_content</code> - The actual content of the file.</p></li><li><p><code>comments</code> - The content of any of the comments on a file or folder.</p></li><li><p><code>tag</code> - Any tags that are applied to an item, as defined by its <code>tag</code> field.</p></li></ul></div></div></td><td></td><td></td></tr><tr><td><p>type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>FILE</p></li><li><p>FOLDER</p></li><li><p>WEB_LINK</p></li></ul></div></div></td><td><div><div><p>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:</p></div><div><ul><li><p><code>file</code> - Limits the search results to files</p></li><li><p><code>folder</code> - Limits the search results to folders</p></li><li><p><code>web_link</code> - Limits the search results to web links, also known as bookmarks</p></li></ul></div></div></td><td></td><td></td></tr><tr><td><p>Trash content</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NON_TRASHED_ONLY</p></li><li><p>TRASHED_ONLY</p></li></ul></div></div></td><td><div><div><p>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 (<code>non_trashed_only</code>).</p></div><div><ul><li><p><code>trashed_only</code> - Only searches for items currently in the trash</p></li><li><p><code>non_trashed_only</code> - Only searches for items currently not in the trash</p></li></ul></div></div></td><td><p>NON_TRASHED_ONLY</p></td><td></td></tr><tr><td><p>mdfilters</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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 <code>query</code> parameter is provided.</p></td><td></td><td></td></tr><tr><td><p>sort</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>MODIFIED_AT</p></li><li><p>RELEVANCE</p></li></ul></div></div></td><td><div><div><p>Defines the order in which search results are returned. This API defaults to returning items by relevance unless this parameter is explicitly specified:</p></div><div><ul><li><p><code>relevance</code> (default) returns the results sorted by relevance to the query search term. The relevance is based on the occurrence of the search term in the items name, description, content, and additional properties.</p></li><li><p><code>modified_at</code> returns the results ordered in descending order by date at which the item was last modified.</p></li></ul></div></div></td><td><p>RELEVANCE</p></td><td></td></tr><tr><td><p>direction</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>DESC</p></li><li><p>ASC</p></li></ul></div></div></td><td><p>Defines the direction in which search results are ordered. This API defaults to returning items in descending (<code>DESC</code>) order unless this parameter is explicitly specified. When results are sorted by <code>relevance</code> the ordering is locked to returning items in descending order of relevance, and this parameter is ignored.</p></td><td><p>DESC</p></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Defines the maximum number of items to return as part of a page of results.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Include recent shared links</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>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)</p></td><td><p>false</p></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>The offset of the item at which to begin the response.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any * Any * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>If none match</p></td><td><div><div><p>String</p></div></div></td><td><p>Ensures an item is only returned if it has changed. Pass in the item’s last observed <code>etag</code> value into this header and the endpoint will fail with a <code>304 Not Modified</code> if the item has not changed since.</p></td><td></td><td></td></tr><tr><td><p>boxapi</p></td><td><div><div><p>String</p></div></div></td><td><p>A header containing the shared link and optional password for the shared link. The format for this header is as follows. <code>shared_link=[link]&amp;shared_link_password=[password]</code></p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Find 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>If none match</p></td><td><div><div><p>String</p></div></div></td><td><p>Ensures an item is only returned if it has changed. Pass in the item’s last observed <code>etag</code> value into this header and the endpoint will fail with a <code>304 Not Modified</code> if the item has not changed since.</p></td><td></td><td></td></tr><tr><td><p>boxapi</p></td><td><div><div><p>String</p></div></div></td><td><p>A header containing the shared link and optional password for the shared link. The format for this header is as follows. <code>shared_link=[link]&amp;shared_link_password=[password]</code></p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Storage policy id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the storage policy.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>Resolved for type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>USER</p></li><li><p>ENTERPRISE</p></li></ul></div></div></td><td><p>The target type to return assignments for</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Resolved for id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the user or enterprise to return assignments for</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Storage policy assignment id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the storage policy assignment.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Task assignment id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the task assignment.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Task id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the task.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Task id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the task.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Tos id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the terms of service.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>User id</p></td><td><div><div><p>String</p></div></div></td><td><p>Limits results to the given user ID.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Tos type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>EXTERNAL</p></li><li><p>MANAGED</p></li></ul></div></div></td><td><p>Limits the results to the terms of service of the given type.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Terms of service id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the terms of service.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List enterprise 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Filter term</p></td><td><div><div><p>String</p></div></div></td><td><p>Limits the results to only users who’s <code>name</code> or <code>login</code> start with the search term. For externally managed users, the search term needs to completely match the in order to find the user, and it will only return one user at a time.</p></td><td></td><td></td></tr><tr><td><p>User type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALL</p></li><li><p>MANAGED</p></li><li><p>EXTERNAL</p></li></ul></div></div></td><td><div><div><p>Limits the results to the kind of user specified.</p></div><div><ul><li><p><code>all</code> returns every kind of user for whom the <code>login</code> or <code>name</code> partially matches the <code>filter_term</code>. It only returns an external user if the login matches the <code>filter_term</code> completely, and in that case it only returns that user.</p></li><li><p><code>managed</code> returns all managed and app users for whom the <code>login</code> or <code>name</code> partially matches the <code>filter_term</code>.</p></li><li><p><code>external</code> returns all external users for whom the <code>login</code> matches the <code>filter_term</code> exactly.</p></li></ul></div></div></td><td></td><td></td></tr><tr><td><p>External app user id</p></td><td><div><div><p>String</p></div></div></td><td><p>Limits the results to app users with the given <code>external_app_user_id</code> value. When creating an app user, an <code>external_app_user_id</code> value can be set. This value can then be used in this endpoint to find any users that match that <code>external_app_user_id</code> value.</p></td><td></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>The offset of the item at which to begin the response.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>DO NOT USE - usemarker</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>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 <code>marker</code> field that can be passed as a parameter to this endpoint to get the next page of the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>DO NOT USE - marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get user 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>User id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the user.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>User id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the user.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>User id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the user.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>User id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the user.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>The offset of the item at which to begin the response.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Web link id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the web link.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>boxapi</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>shared_link=[link]</code> or if a password is required then use <code>shared_link=[link]&amp;shared_link_password=[password]</code>. This header can be used on the file or folder shared, as well as on any files or folders nested within the item.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get trashed 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Web link id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the web link.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## List all 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>marker</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires <code>usemarker</code> to be set to <code>true</code>.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of items to return per page.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Array of * Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Webhook id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the webhook.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>(DEPRECATED) Zip download id</p></td><td><div><div><p>String</p></div></div></td><td><p>The unique identifier that represents this <code>zip</code> archive.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Zip download URL generated by 'Create zip download' operation</p></td><td><div><div><p>String</p></div></div></td><td><p>The temporary URL to download the <code>zip</code> archive.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Get 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Zip download id</p></td><td><div><div><p>String</p></div></div></td><td><p>The unique identifier that represent this <code>zip</code> archive.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The id of the resource owner which access should be invalidated</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Collaboration id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the collaboration</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Comment id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the comment.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File request id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/filerequest/123">https://*.app.box.com/filerequest/123</a></code> the <code>file_request_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>If match</p></td><td><div><div><p>String</p></div></div></td><td><p>Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed <code>etag</code> value into this header and the endpoint will fail with a <code>412 Precondition Failed</code> if it has changed since.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Add 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Explicitly request the <code>shared_link</code> fields to be returned for this item.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>If match</p></td><td><div><div><p>String</p></div></div></td><td><p>Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed <code>etag</code> value into this header and the endpoint will fail with a <code>412 Precondition Failed</code> if it has changed since.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>scope</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>GLOBAL</p></li><li><p>ENTERPRISE</p></li></ul></div></div></td><td><p>The scope of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Template key</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Array of Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Array of Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Array of Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Explicitly request the <code>shared_link</code> fields to be returned for this item.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Explicitly request the <code>shared_link</code> fields to be returned for this item.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Upload 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Upload session id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the upload session.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>digest</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>sha=BASE64_ENCODED_DIGEST</code>. [1]: <a href="https://datatracker.ietf.org/doc/html/rfc3230">https://datatracker.ietf.org/doc/html/rfc3230</a></p></td><td></td><td><p>X</p></td></tr><tr><td><p>Content range</p></td><td><div><div><p>String</p></div></div></td><td><p>The byte range of the chunk. Must not overlap with the range of a part already uploaded this session.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>String</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code>https://*.app.box.com/files/123</code> the <code>file_id</code> is <code>123</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Add 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Explicitly request the <code>shared_link</code> fields to be returned for this item.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>If match</p></td><td><div><div><p>String</p></div></div></td><td><p>Ensures this item hasn’t recently changed before making changes. Pass in the item’s last observed <code>etag</code> value into this header and the endpoint will fail with a <code>412 Precondition Failed</code> if it has changed since.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>scope</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>GLOBAL</p></li><li><p>ENTERPRISE</p></li></ul></div></div></td><td><p>The scope of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Template key</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Array of Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Array of Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Remove 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Explicitly request the <code>shared_link</code> fields to be returned for this item.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Explicitly request the <code>shared_link</code> fields to be returned for this item.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Folder id</p></td><td><div><div><p>String</p></div></div></td><td><p>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 <code><a href="https://*.app.box.com/folder/123">https://*.app.box.com/folder/123</a></code> the <code>folder_id</code> is <code>123</code>. The root folder of a Box account is always represented by the ID <code>0</code>.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Group membership id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the group membership.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Group id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the group.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Legal hold policy id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the legal hold policy</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Add classification

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Array of Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Delete 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Array of Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Array of Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>scope</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>GLOBAL</p></li><li><p>ENTERPRISE</p></li></ul></div></div></td><td><p>The scope of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Template key</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the metadata template</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Array of Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Retention policy id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the retention policy.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Skill id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the skill to apply this metadata for.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Storage policy assignment id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the storage policy assignment.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Task assignment id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the task assignment.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Task id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the task.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Terms of service user status id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the terms of service status.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Terms of service id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the terms of service.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>User id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the user.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>User id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the user.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>notify</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Determines if users should receive email notification for the action performed.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Web link id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the web link.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Webhook id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the webhook.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>the content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>X</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit that qualifies the <strong>Response Timeout</strong>.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p><strong>Attributes Type</strong></p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

### Throws

- BOX:BAD\_REQUEST

- BOX:CLIENT\_ERROR

- BOX:CONNECTIVITY

- BOX:INTERNAL\_SERVER\_ERROR

- BOX:NOT\_ACCEPTABLE

- BOX:NOT\_FOUND

- BOX:RETRY\_EXHAUSTED

- BOX:SERVER\_ERROR

- BOX:SERVICE\_UNAVAILABLE

- BOX:TIMEOUT

- BOX:TOO\_MANY\_REQUESTS

- BOX:UNAUTHORIZED

- BOX:UNSUPPORTED\_MEDIA\_TYPE

## Sources

## On Download File Trigger

`<box:on-download-file-listener>`

Initiates a flow when a download file event occurs.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Folder ID</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the folder.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Include sub-folders</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Determines whether to include subfolders or not.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Primary Node Only</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether this source should only be executed on the primary node when running in a cluster.</p></td><td></td><td></td></tr><tr><td><p>Scheduling Strategy</p></td><td><div><div><p>scheduling-strategy</p></div></div></td><td><p>Configures the scheduler that triggers the polling.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Redelivery Policy</p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><p>Defines a policy for processing the redelivery of the same message.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

## On New File in Folder

`<box:on-new-file-in-folder-listener>`

Initiates a flow when a file is created in a folder.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Folder ID</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the folder.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Include sub-folders</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Determines whether to include subfolders or not.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Primary Node Only</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether this source should only be executed on the primary node when running in a cluster.</p></td><td></td><td></td></tr><tr><td><p>Scheduling Strategy</p></td><td><div><div><p>scheduling-strategy</p></div></div></td><td><p>Configures the scheduler that triggers the polling.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Redelivery Policy</p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><p>Defines a policy for processing the redelivery of the same message.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

## On New Folder

`<box:on-new-folder-listener>`

Initiates a flow when a folder is created in a folder.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Folder ID</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the folder.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Include sub-folders</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Determines whether to include subfolders or not.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Primary Node Only</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether this source should only be executed on the primary node when running in a cluster.</p></td><td></td><td></td></tr><tr><td><p>Scheduling Strategy</p></td><td><div><div><p>scheduling-strategy</p></div></div></td><td><p>Configures the scheduler that triggers the polling.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Redelivery Policy</p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><p>Defines a policy for processing the redelivery of the same message.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

## On New Task Created

`<box:on-new-task-created-listener>`

Initiates a flow when a task assignment is created.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Assigned To</p></td><td><div><div><p>String</p></div></div></td><td><p>The user to assign the task to.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Primary Node Only</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether this source should only be executed on the primary node when running in a cluster.</p></td><td></td><td></td></tr><tr><td><p>Scheduling Strategy</p></td><td><div><div><p>scheduling-strategy</p></div></div></td><td><p>Configures the scheduler that triggers the polling.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Redelivery Policy</p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><p>Defines a policy for processing the redelivery of the same message.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Configurations](#configurations)

## Types

### Default Header

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Key</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Value</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr></tbody></table>

### Default Query Param

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Key</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Value</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr></tbody></table>

### Proxy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Non Proxy Hosts</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr></tbody></table>

### Reconnection

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Fails Deployment</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>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</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>The reconnection strategy to use</p></td><td></td><td></td></tr></tbody></table>

### Reconnect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>How often (in ms) to reconnect</p></td><td></td><td></td></tr><tr><td><p>Blocking</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If false, the reconnection strategy will run in a separate, non-blocking thread</p></td><td></td><td></td></tr><tr><td><p>Count</p></td><td><div><div><p>Number</p></div></div></td><td><p>How many reconnection attempts to make</p></td><td></td><td></td></tr></tbody></table>

### Reconnect Forever

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>How often (in ms) to reconnect</p></td><td></td><td></td></tr><tr><td><p>Blocking</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If false, the reconnection strategy runs in a separate, non-blocking thread.</p></td><td></td><td></td></tr></tbody></table>

### Tls

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Enabled Protocols</p></td><td><div><div><p>String</p></div></div></td><td><p>A comma-separated list of protocols enabled for this context.</p></td><td></td><td></td></tr><tr><td><p>Enabled Cipher Suites</p></td><td><div><div><p>String</p></div></div></td><td><p>A comma-separated list of cipher suites enabled for this context.</p></td><td></td><td></td></tr><tr><td><p>Trust Store</p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Key Store</p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Revocation Check</p></td><td><div><div><ul><li><p><a href="#StandardRevocationCheck">Standard Revocation Check</a></p></li><li><p><a href="#CustomOcspResponder">Custom Ocsp Responder</a></p></li><li><p><a href="#CrlFile">Crl File</a></p></li></ul></div></div></td><td></td><td></td><td></td></tr></tbody></table>

### Trust Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the trust store.</p></td><td></td><td></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of store used.</p></td><td></td><td></td></tr><tr><td><p>Algorithm</p></td><td><div><div><p>String</p></div></div></td><td><p>The algorithm used by the trust store.</p></td><td></td><td></td></tr><tr><td><p>Insecure</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.</p></td><td></td><td></td></tr></tbody></table>

### Key Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.</p></td><td></td><td></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The type of store used.</p></td><td></td><td></td></tr><tr><td><p>Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Key Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the private key.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password used to protect the key store.</p></td><td></td><td></td></tr><tr><td><p>Algorithm</p></td><td><div><div><p>String</p></div></div></td><td><p>The algorithm used by the key store.</p></td><td></td><td></td></tr></tbody></table>

### Standard Revocation Check

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Only End Entities</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Only verify the last element of the certificate chain.</p></td><td></td><td></td></tr><tr><td><p>Prefer Crls</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Try CRL instead of OCSP first.</p></td><td></td><td></td></tr><tr><td><p>No Fallback</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Do not use the secondary checking method (the one not selected before).</p></td><td></td><td></td></tr><tr><td><p>Soft Fail</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Avoid verification failure when the revocation server can not be reached or is busy.</p></td><td></td><td></td></tr></tbody></table>

### Custom Ocsp Responder

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The URL of the OCSP responder.</p></td><td></td><td></td></tr><tr><td><p>Cert Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>Alias of the signing certificate for the OCSP response (must be in the trust store), if present.</p></td><td></td><td></td></tr></tbody></table>

### Crl File

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path to the CRL file.</p></td><td></td><td></td></tr></tbody></table>

### Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max Idle Time</p></td><td><div><div><p>Number</p></div></div></td><td><p>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</p></td><td></td><td></td></tr><tr><td><p>Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the maxIdleTime attribute</p></td><td></td><td></td></tr></tbody></table>

### Http Response Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Status Code</p></td><td><div><div><p>Number</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Reason Phrase</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr></tbody></table>

### Repeatable In Memory Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Initial Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Buffer Size Increment</p></td><td><div><div><p>Number</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Max Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit in which all these attributes are expressed</p></td><td></td><td></td></tr></tbody></table>

### Repeatable File Store Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>In Memory Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit in which maxInMemorySize is expressed</p></td><td></td><td></td></tr></tbody></table>

### Redelivery Policy

Configures the redelivery policy for executing requests that generate errors. You can add a
redelivery policy to any source in a flow.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max Redelivery Count</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of times that a delivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.</p></td><td></td><td></td></tr><tr><td><p>Message Digest Algorithm</p></td><td><div><div><p>String</p></div></div></td><td><p>Secure hashing algorithm to use if the <strong>Use Secure Hash</strong> field is <code>true</code>. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s <code>hashCode()</code> returned.</p></td><td></td><td></td></tr><tr><td><p>Message Identifier</p></td><td><div><div><p><a href="#RedeliveryPolicyMessageIdentifier">Redelivery Policy Message Identifier</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Object Store</p></td><td><div><div><p>ObjectStore</p></div></div></td><td><p>Configures the object store that stores the redelivery counter for each message.</p></td><td></td><td></td></tr></tbody></table>

### Redelivery Policy Message Identifier

Configures how to identify a redelivered message and how to find out when the message was
redelivered.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Use Secure Hash</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If <code>true</code>, Mule uses a secure hash algorithm to identify a redelivered message.</p></td><td></td><td></td></tr><tr><td><p>Id Expression</p></td><td><div><div><p>String</p></div></div></td><td><p>Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if the <strong>Use Secure Hash</strong> field is false.</p></td><td></td><td></td></tr></tbody></table>

### Repeatable In Memory Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Initial Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>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.</p></td><td><p>100</p></td><td></td></tr><tr><td><p>Buffer Size Increment</p></td><td><div><div><p>Number</p></div></div></td><td><p>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.</p></td><td><p>100</p></td><td></td></tr><tr><td><p>Max Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr></tbody></table>

### Repeatable File Store Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>In Memory Objects</p></td><td><div><div><p>Number</p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit in which maxInMemorySize is expressed</p></td><td></td><td></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)