Box
App Vendor: Box
App Category: IT Services
Connector Version: 1.0.0
API Version: 1.0.0
About App
Box provides a single platform for secure content management, workflow, and collaboration. The Box app can be used to manage files and folders in the Box application.
The Box app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
|---|---|
Download File | This action downloads a file from Box. |
Get File Details | This action retrieves details about a file from Box. |
Get Folder Details | This action retrieves details about a folder from Box. |
List Items in Folder | This action retrieves the list of all items in a folder. |
List Users | This action retrieves the list of all enterprise users. |
Search for Content | This action searches for content in Box. |
Upload File | This action uploads a file to Box. This action is limited to 50 MB of data and returns an error if the same file already exists. |
Configuration Parameters
The following configuration parameters are required for the Box app to communicate with the Box enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User ID | Enter the user ID to authenticate your Box application. Example: 285160924 | Integer | Required | |
Client ID | Enter the client ID of the application that will be used to connect to the Box application. Example: "f6or365do9pzyqghzbbckpqq5lx9vwrn" | Text | Required | |
Client Secret | Enter the client secret of the application that will be used to connect to the Box application. Example: "obyatycaskjhff6tzkbscoqgnimra5vn" | Password | Required |
Action: Download File
This action downloads a file from Box.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
File ID | Enter the file ID to download. Example: "123456789" | Text | Required | |
User ID | If you are downloading this file from a user's account, provide the user ID or user e-mail address of that account. Example: "john.doe@sampledomain.com" | Text | Optional |
Example Request
[
{
"file_id": "941560758409",
"user_id": "john.doe@sampledomain.com"
}
]Action: Get File Details
This action retrieves details about a file from Box.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
File ID | Enter the file ID of the file to get details about. Example: "123456789" | Text | Required | |
User ID | If the file is from a user's account, provide the user id or user e-mail address of that account. Example: "john.doe@sampledomain.com" | Text | Optional |
Example Request
[
{
"file_id": "941560758409",
"user_id": "john.doe@sampledomain.com"
}
]Action: Get Folder Details
This action retrieves details about a folder from Box.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Folder ID | Enter the folder ID of the folder to get details. Example: "123456789" | Text | Required |
|
User ID | If this file is from a user's account, provide the user ID or user e-mail address of that account. Example: "john.doe@sampledomain.com" | Text | Optional |
|
Example Request
[
{
"user_id": "john.doe@sampledomain.com",
"folder_id": 123456789
}
]Action: List Items in Folder
This action retrieves the list of all items in a folder.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User ID | Enter the user ID of the account to look in. This can be the user ID or email associated with the account. Example: "john.doe@hotmail.com" | Text | Required | |
Folder ID | Enter the folder ID to list items from. The root folder is identified as 0. Example: 123456789 | Integer | Optional |
Example Request
[
{
"user_id": "john.doe@sampledomain.com",
"folder_id": 123456789
}
]Action: List Users
This action retrieves the list of all enterprise users.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Filter term | Enter the query. You can filter the results only users who's name or login start with the search term. Example: "testuser@sampledomain.com" | Text | Optional |
Example Request
[
{
"user_id": "testuser@sampledomain.com"
}
]Action: Search for Content
This action searches for content in Box.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Search query | Enter the query string to search for. The query is matched against item names, descriptions, text content of files, and various other fields of the different item types. Example: "Sample File" | Text | Required | |
User ID | If you are searching as a user, provide the user ID or user e-mail address of that account. Example: "john.doe@hotmail.com" | Text | Optional | |
Limit | Enter the number of results to return. Example: 30 | Integer | Optional | Default value: 200 Maximum Limit: 200 |
Offset | Enter the offset of the item at which to begin the response. Example: 3 | Integer | Optional | Default value: 0 |
Item type | Enter the query to limit the search results to any items of the specified type. This parameter only takes one value. By default the api returns items that match any of these types. | Text | Optional | Allowed values:
|
Ancestor folder IDs | Enter the query to limit the search results to items within the given list of folders, defined as a comma separated lists of folder IDs. The search result will also include items within any subfolders of those ancestor folders. Example: multiple folders: "4535234,234123235,2654345" single folder: "123456789" | Text | Optional | |
Content types | Enter the query to limit the search results to any items that match the search query for a specific part of the file. Example: "description" | Text | Optional | Allowed values:
|
Owner user IDs | Enter the query to limit the search results to any items that are owned by the given list of owners, defined as a list of comma separated user IDs. 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. Example: multiple users: "123422,23532,3241212" single user: "123456789" | Text | Optional | |
Created at range | Enter the query to limit 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 skipped (,2014-05-17t13:35:01-07:00) anything created before the end date will be returned. If the end date is skipped (2014-05-15t13:35:01-07:00,) the current date will be used as the end date instead. Example: "2014-05-15t13:35:01-07:00,2014-05-17t13:35:01-07:00" | Text | Optional | |
Updated at range | Enter the query to limit 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 skipped (,2014-05-17t13:35:01-07:00) anything updated before the end date will be returned. If the end date is skipped (2014-05-15t13:35:01-07:00,) the current date will be used as the end date instead. Example: "2014-05-15t13:35:01-07:00,2014-05-17t13:35:01-07:00" | Text | Optional | |
Scope | Enter the query to limit the search results to either the files that the user has access to, or to files available to the entire enterprise. Example: "user_content" | Text | Optional | Allowed values:
Default values:
|
Example Request
[
{
"scope": "enterprise_content",
"search_query": "sample file"
}
]Action: Upload File
This action uploads a file to Box. This action is limited to 50 MB of data and returns an error if the same file already exists.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Local file name | Enter the file to upload. Example: "tmp/12345679/doc.txt" | Text | Required | |
File name | Enter the file name to write to box. Example: "test.txt" | Text | Required | |
Parent ID | Specify if the file is being written to a sub folder put the folder ID here. Example: "123456789" | Text | Optional | |
User ID | Enter the user's directory to upload to. If this is skipped, the service account associated with the enterprise app will be used. Example: "123456789" | Text | Optional |
Example Request
[
{
"user_id": "john.doe@sampledomain.com",
"file_name": "workflow_test.txt",
"local_file_name": "/tmp/a61013ed-2d69-416b-85aa-c62f7e17059e/sample_file.txt"
}
]