Nav

Box Connector Module Documentation Reference

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

Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

config_connection, Connection

The connection types that can be provided to this configuration.

x

host

String

Host for consuming API.

api.box.com

port

String

Port for consuming API.

443

basePath

String

Basepath for consuming API.

/2.0

protocol

String

Protocol for consuming API.

HTTPS

clientId

String

OAuth2 Client ID.

x

clientSecret

String

OAuth2 Client Secret

x

localCallbackPath

String

Path for autogenerating the local callback endpoint.

/callback

localCallbackConfig

String

HTTP Listener Configuration name for exposing the callback endpoint.

cloudhub_http

externalCallbackUrl

String

URL for redirecting after the OAuth dance login.

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

localAuthorizationUrl

String

Local URL for autogenerating the endpoint that starts the OAuth dance

http://localhost:8081/authorize

authorizationUrl

String

Authorize URL for consuming API.

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

accessTokenUrl

String

Token URL for consuming API.

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

Expiration Policy

ExpirationPolicy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean the platform expires an eligible instance. The runtime purges instances as it sees fit.

Box Connector Operations

  • Copy File

  • Copy Folder

  • Create Collaboration

  • Create Comment

  • Create Folder

  • Create Group

  • Create Group Membership

  • Create Task

  • Create Task Assignment

  • Create User

  • Delete Collaboration

  • Delete Comment

  • Delete File

  • Delete File Version

  • Delete Folder

  • Delete Group

  • Delete Group Membership

  • Delete Task

  • Delete Task Assignment

  • Delete Trashed File

  • Delete Trashed Folder

  • Delete User

  • Get Collaboration

  • Get Comment

  • Get Enterprise Groups

  • Get Enterprise Users

  • Get File

  • Get File Comments

  • Get File Content

  • Get File Tasks

  • Get File Thumbnail

  • Get File Versions

  • Get Folder

  • Get Folder Collaborations

  • Get Folder Items

  • Get Group

  • Get Group Membership

  • Get Group Memberships

  • Get Pending Collaborations

  • Get Task

  • Get Task Assignment

  • Get Task Assignments

  • Get Trashed File

  • Get Trashed Folder

  • Get Trashed Items

  • Get User

  • Get User Group Membership

  • Promote File Version

  • Restore Trashed File

  • Restore Trashed Folder

  • Search

  • Update Collaboration

  • Update Comment

  • Update File Info

  • Update Folder

  • Update Group Membership

  • Update Task

  • Update Task Assignment

  • Update User

  • Update User Folder

Copy File

<mule-box-connector:copy-file>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Copy File Request Data

Any

#[payload]

File Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Copy Folder

<mule-box-connector:copy-folder>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Copy Folder Request Data

Any

#[payload]

Fields

String

Attributes to include in the response.

Folder Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Create Collaboration

<mule-box-connector:create-collaboration>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Collaboration Request Data

Any

#[payload]

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Create Comment

<mule-box-connector:create-comment>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Comment Request Data

Any

#[payload]

Fields

String

Attribute(s) to include in the response.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Create Folder

<mule-box-connector:create-folder>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Folder Request Data

Any

#[payload]

Fields

String

Attribute(s) to include in the response

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Create Group

<mule-box-connector:create-group>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Group Request Data

Any

#[payload]

Fields

String

Attribute(s) to include in the response

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Create Group Membership

<mule-box-connector:create-group-membership>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Group Membership Request Data

Any

#[payload]

Fields

String

Attribute(s) to include in the response

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Create Task

<mule-box-connector:create-task>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Task Request Data

Any

#[payload]

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Create Task Assignment

<mule-box-connector:create-task-assignment>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Task Assignment Request Data

Any

#[payload]

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Create User

<mule-box-connector:create-user>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create User Request Data

Any

#[payload]

Fields

String

Attribute(s) to include in the response

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Delete Collaboration

<mule-box-connector:delete-collaboration>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collab Id

String

x

For Configurations

  • config

Delete Comment

<mule-box-connector:delete-comment>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Comment Id

String

x

For Configurations

  • config

Delete File

<mule-box-connector:delete-file>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Id

String

x

If Match

String

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

For Configurations

  • config

Delete File Version

<mule-box-connector:delete-file-version>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Id

String

x

Version Id

String

x

If Match

String

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

For Configurations

  • config

Delete Folder

<mule-box-connector:delete-folder>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Recursive

Boolean

Folder Id

String

x

If Match

String

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

For Configurations

  • config

Delete Group

<mule-box-connector:delete-group>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Group Id

String

x

For Configurations

  • config

Delete Group Membership

<mule-box-connector:delete-group-membership>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Group Membership Id

String

x

For Configurations

  • config

Delete Task

<mule-box-connector:delete-task>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Task Id

String

x

For Configurations

  • config

Delete Task Assignment

<mule-box-connector:delete-task-assignment>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Task Assignment Id

String

x

For Configurations

  • config

Delete Trashed File

<mule-box-connector:delete-trashed-file>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Id

String

x

For Configurations

  • config

Delete Trashed Folder

<mule-box-connector:delete-trashed-folder>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Folder Id

String

x

For Configurations

  • config

Delete User

<mule-box-connector:delete-user>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Notify

Boolean

Force

Boolean

User Id

String

x

For Configurations

  • config

Get Collaboration

<mule-box-connector:get-collaboration>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response

Status

String

Can only be pending

Collab Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get Comment

<mule-box-connector:get-comment>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response.

Comment Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get Enterprise Groups

<mule-box-connector:get-enterprise-groups>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response

Limit

Number

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

Offset

Number

The item at which to begin the response.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get Enterprise Users

<mule-box-connector:get-enterprise-users>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response

Filter Term

String

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

Limit

Number

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

Offset

Number

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

User Type

String

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

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get File

<mule-box-connector:get-file>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response.

File Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get File Comments

<mule-box-connector:get-file-comments>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response

File Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get File Content

<mule-box-connector:get-file-content>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Version

String

The ID specific version of this file to download.

File Id

String

x

Range

String

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

Box Api

String

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

For Configurations

  • config

Get File Tasks

<mule-box-connector:get-file-tasks>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response

File Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get File Thumbnail

<mule-box-connector:get-file-thumbnail>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Min Height

Number

The minimum height of the thumbnail

Min Width

Number

The minimum width of the thumbnail

Max Height

Number

The maximum height of the thumbnail

Max Width

Number

The maximum width of the thumbnail

File Id

String

x

Extension

String

The preview format, for example, . png or jpg

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get File Versions

<mule-box-connector:get-file-versions>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response

File Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get Folder

<mule-box-connector:get-folder>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response

Folder Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get Folder Collaborations

<mule-box-connector:get-folder-collaborations>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response

Limit

Number

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

Offset

Number

The item at which to begin the response

Folder Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get Folder Items

<mule-box-connector:get-folder-items>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response

Limit

Number

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

Offset

String

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

Folder Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get Group

<mule-box-connector:get-group>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response

Group Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get Group Membership

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response

Group Membership Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get Group Memberships

<mule-box-connector:get-group-memberships>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response

Limit

Number

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

Offset

Number

The item at which to begin the response.

Group Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get Pending Collaborations

<mule-box-connector:get-pending-collaborations>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response

Status

String

Must be 'pending'

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get Task

<mule-box-connector:get-task>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response

Task Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get Task Assignment

<mule-box-connector:get-task-assignment>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response

Task Assignment Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get Task Assignments

<mule-box-connector:get-task-assignments>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response

Task Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get Trashed File

<mule-box-connector:get-trashed-file>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get Trashed Folder

<mule-box-connector:get-trashed-folder>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response

Folder Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get Trashed Items

<mule-box-connector:get-trashed-items>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response.

Limit

Number

The maximum number of items to return.

Offset

Number

The item at which to begin the response.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get User

<mule-box-connector:get-user>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response.

User Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get User Group Membership

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Attribute(s) to include in the response.

Limit

Number

Default is 100. Max is 1000.

Offset

Number

The item at which to begin the response.

User Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Promote File Version

<mule-box-connector:promote-file-version>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Promote File Version Request Data

Any

#[payload]

File Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Restore Trashed File

<mule-box-connector:restore-trashed-file>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Restore Trashed File Request Data

Any

#[payload]

File Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Restore Trashed Folder

<mule-box-connector:restore-trashed-folder>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Restore Trashed Folder Request Data

Any

#[payload]

Fields

String

Attribute(s) to include in the response.

Folder Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

<mule-box-connector:search>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query

String

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

x

Scope

String

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

File Extensions

String

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

Created At Range

Date

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

Updated At Range

Date

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

Size Range

Number

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

Owner User Ids

String

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

Ancestor Folder Ids

String

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

Content Types

String

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

Type

String

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

Trash Content

String

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

Mdfilters

String

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

Limit

Number

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

Offset

Number

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

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Update Collaboration

<mule-box-connector:update-collaboration>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Update Collaboration Request Data

Any

#[payload]

Collab Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Update Comment

<mule-box-connector:update-comment>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Update Comment Request Data

Any

#[payload]

Fields

String

Attribute(s) to include in the response.

Comment Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Update File Info

<mule-box-connector:update-file-info>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Update File Info Request Data

Any

#[payload]

File Id

String

x

If Match

String

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

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Update Folder

<mule-box-connector:update-folder>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Update Folder Request Data

Any

#[payload]

Fields

String

Attribute(s) to include in the response.

Folder Id

String

x

If Match

String

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

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Update Group Membership

<mule-box-connector:update-group-membership>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Update Group Membership Request Data

Any

#[payload]

Fields

String

Attribute(s) to include in the response.

Group Membership Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Update Task

<mule-box-connector:update-task>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Update Task Request Data

Any

#[payload]

Fields

String

Attribute(s) to include in the response.

Task Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Update Task Assignment

<mule-box-connector:update-task-assignment>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Update Task Assignment Request Data

Any

#[payload]

Task Assignment Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Update User

<mule-box-connector:update-user>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Update User Request Data

Any

#[payload]

Fields

String

Attribute(s) to include in the response.

User Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Update User Folder

<mule-box-connector:update-user-folder>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Update User Folder Request Data

Any

#[payload]

Notify

Boolean

Fields

String

Attribute(s) to include in the response.

User Id

String

x

Folder Id

String

x

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Types

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute.