Box Adapter

The Box Adapter gives you access to Files and Folders using SQL commands and REST requests.

This adapter requires a subscription with the Box service.

Want to try it in Azure? Click here to learn more or click here to create a new Enzo Server RTM 3.1 Azure VM now.

Want to try it in AWS? Click here to learn more or click here to create a new Enzo Server RTM 3.1 AWS VM now.

OAuth Configuration

This adapter requires OAuth to be configured.

Download the Box configuration instructions

Configuration Settings

Name	Description	Default
Boolean _isDefault	Make this the default configuration. Defaults to true if configName is already the default.
String accessToken	The Box service accessToken assigned to you
String refreshToken	The Box refreshToken
String clientId	The clientId assigned to your registered application
String clientSecret	The app client secret key assigned to your application

Handlers

CreateFolder
Folders

Create a new folder at specific path details

Arguments

Name	Description	Default
folderName R	Name of the folder
parentFolder	Name of the parent folder to create folder within it

SQL Call

EXEC Box.CreateFolder 'test'
INSERT INTO Box.Folders (folderName) VALUES ('test')

Http Call

/box/createfolder

Output Columns

This call does not return data.

DeleteFile
files

Delete file given a file name details

Arguments

Name	Description	Default
fileName R	The file to delete

SQL Call

EXEC Box.DeleteFile  @fileName='abc.txt'
DELETE FROM Box.files where fileName='abc.txt'

Http Call

/box/deletefile

Output Columns

This call does not return data.

DeleteFolder
Folders

Delete folder given the folder name details

Arguments

Name	Description	Default
folderName R	The folder Name to delete

SQL Call

EXEC Box.DeleteFolder @folderName='/TestFolder1'
DELETE FROM Box.Folders where folderName='/TestFolder1'

Http Call

/box/deletefolder

Output Columns

This call does not return data.

DownloadFile

upload file at box on given path details

Arguments

Name	Description	Default
fileName R	name of the file to download
downloadPath	Name of the file to download to; leave blank to download a TMP file
override	If true, overrides file if it already exists (default: 0)	False
timeout	Timeout operation in minutes - default: 0 (no timeout)	0
retryCount	Retry count (default: 3)	3

SQL Call

EXEC Box.DownloadFile '/abc.txt'

Http Call

/box/downloadfile

Output Columns

String fileId
String fileName
String tmpFileName
Int64 byteTx
Double elapsedTime

getAuthURL
authURL

Get Authentication url details

Arguments

SQL Call

EXEC Box.getAuthURL
SELECT * FROM Box.authURL

Http Call

/box/getauthurl

Output Columns

String url

getTokens
tokens

Get authentication token details

Arguments

Name	Description	Default
codeResponse R	The required code provided by the Box authentication response obtained by the user, after pasting the URL provided by getAuthURL

SQL Call

EXEC Box.getTokens  'code here from getAuthURL Function'
SELECT * FROM Box.tokens where codeResponse='code here from getAuthURL Function'

Http Call

/box/gettokens

Output Columns

String code
String accessToken
String token_type
Int32 expiredIn
String refreshToken

ListFiles
Files

Read all the files from Box root or folder specified details

Arguments

Name	Description	Default
folderName	The folder Name in which the files should be returned

SQL Call

EXEC Box.ListFiles
SELECT * FROM Box.Files
SELECT * FROM Box.Files WHERE folderName='/'

Http Call

/box/listfiles

Output Columns

String fileId
String fileName
Boolean isFolder

RenameFile
files

Rename an existing file details

Arguments

Name	Description	Default
sourFileName R	The name of the file to rename
fileName R	The new fileName

SQL Call

EXEC Box.renamefile  @sourceFileName='/abc.txt',@fileName='test2.txt'
UPDATE Box.folders set fileName = 'test2.txt' where sourceFileName='/abc.txt'

Http Call

/box/renamefile

Output Columns

This call does not return data.

RenameFolder
folders

Rename the folder details

Arguments

Name	Description	Default
sourceFolderName R	The folder name to rename
folderName R	The new folder name

SQL Call

EXEC Box.renamefolders  @sourceFolderName='/TestFolder',@folderName='test2'
update Box.folders set folderName='test2' where sourceFolderName='/TestFolder'

Http Call

/box/renamefolder

Output Columns

This call does not return data.

UploadFile
File

Upload a file to Box details

Arguments

Name	Description	Default
sourceFile R	Name of the source file
targetFileName R	Name of the target file
override	If true, overrides file if it already exists (default: 0)	False
timeout	Timeout operation in minutes - default: 0 (no timeout)	0

SQL Call

EXEC Box.UploadFile 'c:	mp	est.zip', 'test.zip'
INSERT INTO Box.File (sourceFile,targetFileName) VALUES ('abc.txt','d2.txt')

Http Call

/box/uploadfile

Output Columns

String fileName
String fileId
Int64 byteTx
Double elapsedTime

BLOGS AND VIDEOS

IN THE NEWS

OTHER

Box Adapter

OAuth Configuration

Configuration Settings

Handlers

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

PLATFORM

SOLUTIONS

RESOURCES

COMPANY