This page provides a guide to Establishing a Connection to Box in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Box

Establishing a Connection shows how to authenticate to Box and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Box through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Box by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Box

The Cloud enables access to metadata for Box tables and folders. Note that the Cloud cannot update the contents of files stored on Box or model file content as tables and columns.

Authenticating to Box

The Cloud uses the OAuth authentication standard to connect to Box from either a User account or a Service account.

Box provides embedded OAuth credentials that simplify connection from a Desktop application . To connect from a Web application, you must create a custom OAuth application, as described in Creating a Custom OAuth Application.

The following subsections describe how to authenticate to Box from the available OAuth flows. For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that already have embedded OAuth credentials, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in Box, see Connection.

User Accounts (OAuth)

AuthScheme must be set to OAuth in all user account flows.

Service Account (OAuthJWT)

Service accounts have silent authentication, which does not require user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes to the Cloud.

To use a service account, you must create and authorize a custom OAuth application, as described in Creating a Custom OAuth Application. You can then connect to whatever Box data the service account is permitted to access.

After setting the following connection properties, you are ready to connect:

• AuthScheme: OAuthJWT.
• OAuthClientId: The client Id noted in your custom OAuth application settings.
• OAuthClientSecret: The client secret noted in your custom OAuth application settings.
• OAuthJWTCertType: PEMKEY_FILE.
• OAuthJWTCert: The path to the .pem file you generated.
• OAuthJWTCertPassword: The password of the .pem file.
• OAuthJWTCertSubject: The subject of the certificate. If you want to select the first certificate in the Certificate Store, set an * (asterisk).
• OAuthJWTSubjectType: The same as what you specified in your Application Access Values; either "enterprise" or "user". The default value of this connection property is "enterprise".
• OAuthJWTSubject: If your subject type is set to enterprise, this should be your enterprise Id. If your subject type is set to user, this should be your application user Id.
• OAuthJWTPublicKeyId: The Id of your public key in your application settings.

When you connect the Cloud completes the OAuth flow for a service account.

BOXJSON OAuthJWTCertType

To authenticate using a service account and the BOXJSON OauthJWTCertType, set these properties:

• AuthScheme: OAuthJWT.
• OAuthJWTCertType BOXJSON. OAuthJWTCert: The path to the Box-provided JSON file.

In cases where it may not be feasible to use a file in your system. you can copy the contents of the JSON file directly into the connection string. Set these properties:

• AuthScheme: OAuthJWT.
• OAuthJWTCertType: BOXJSONBLOB.
• OAuthJWTCert: The contents of the Box-provided JSON file.

Creating a Custom OAuth Application

CData embeds OAuth Application Credentials with CData branding that can be used when connecting via a .

You may choose to use your own OAuth Application Credentials when you want to:

• control branding of the authentication dialog
• control the redirect URI that the application redirects the user to after the user authenticates
• customize the permissions that you are requesting from the user

Procedure

This procedure creates a custom OAuth application, registers that application, and generates values that are used to configure the OAuthClientId and OAuthClientSecret.

At the Box Enterprise Developer Console:

1. Log in to your Box developers dashboard.
2. Click Create New App.
3. Specify basic application information, as appropriate.
4. Specify your application type (e.g., Custom App).
5. Select the User Authentication (OAuth 2.0) authentication method.
6. Set the Redirect URI:
   • If this is a , set the Redirect URI to http://localhost:33333 or a different port number.
7. Click Create App.
8. The next task is to create a public and private key pair.
   • To create a keypair from the Developer Console:
     1. Navigate to the Developer Console Configuration tab.
     2. Scroll down to Add and Manage Public Keys.
     3. Click Generate a Public/Private Keypair. Box creates a keypair in a JSON file, and downloads that file to your desktop. You can then move that file to your application code.

        Note: Box does not back up private keys for security reasons. Be careful to back up the Public/Private JSON file. If you lose your private key, you must reset the entire keypair.

   • To add a keypair manually:
     1. Open a terminal window and run the following OpenSSL commands:
        

        openssl genrsa -des3 -out private.pem 2048
        openssl rsa -in private.pem -outform PEM -pubout -out public.pem

        Note: To run OpenSSL in a Windows environment, install the Cygwin package.

     2. At the Developer Console, navigate to the configuration tab for the Custom OAuth application you just created.
     3. Scroll down to Add and Manage Public Keys.
     4. Click Add a Public Key.
     5. Click Verify and Save.
9. Before the custom application can be used, a Box Admin must authorize it within the Box Admin Console.
   1. Navigate to your application within the Developer Console.
   2. Click the Authorization tab.
   3. At the prompt to Submit app for authorization for access to the Enterprise, click Review and Submit.
      Your Box Enterprise Admin approves the application.
10. Finally, select the scope of user permissions your custom OAuth application must request.

After your application is created and registered, click Configuration from the main menu to access your settings. Note the displayed Redirect URI, Client ID, and Client Secret. You will need these values later.

When JWT Access Scopes Change

If you change the JWT access scopes, you must reauthorize the application in the enterprise admin console:

1. Click Apps in the main manu.
2. Select the ellipsis button next to your JWT application name.
3. Select Reauthorize App in the menu.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Cloud models Box data as an easy-to-use SQL database. There are three parts to the data model: tables, views, and stored procedures.

Tables

The Tables section, which details standard SQL tables, and the Views section, which lists read-only SQL tables, contain samples of what you might have access to in your Box account.

Common tables include:

Table	Description
Bookmarks	Stores and manages bookmarks that reference web links saved within Box, allowing users to create, update, delete, and retrieve them.
Collaborations	Tracks collaboration settings on Box items such as files and folders, including user roles and permissions for shared access.
Collections	Displays collections of items that users have grouped together in Box for easier navigation and organization.
Comments	Contains user comments made on Box files and folders, supporting creation, retrieval, updates, and deletion.
FileMetadataInstances	Retrieves metadata applied to specific files, showing key-value fields associated with metadata templates.
FileVersions	Lists all available versions of a file stored in Box, enabling tracking of file history and access to prior revisions.
Folders	Represents folders in Box, including their structure, contents, and metadata, with full create, update, delete, and query capabilities.
Groups	Manages groups of users in Box for easier collaboration and permission assignment across files and folders.
LegalPolicies	Stores legal hold policies created by an enterprise to preserve content for compliance or litigation purposes.
Memberships	Defines user memberships in groups, linking users to groups and managing their access within Box.
MetadataTemplates	Contains reusable metadata templates that define structured fields which can be applied to files and folders.
RecentItems	Shows a list of items recently accessed by the user, such as files and folders opened in Box.
SharedItems	Retrieves items that have been shared, including their shared links and associated access permissions.
SignRequests	Lists electronic signature requests sent or received through Box Sign, including request status.
TaskAssignments	Represents assignments of tasks within Box, linking a task to the users responsible for completing it.
Tasks	Stores tasks created in Box for files and folders, supporting assignment, due dates, and completion tracking.
TrashedItems	Contains items moved to the trash, allowing users to view, query, or permanently delete trashed files and folders.
UserEvents	Provides a record of user activity events in Box, such as logins, file uploads, shares, and collaborations.
Users	Stores user account details in Box, supporting creation, management, and retrieval of users across the enterprise.

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard create, read, update, delete (CRUD) operations, including downloading, uploading, and copying files.

When they are specified in the SQL statement, the Cloud tries to push LIMIT and OFFSET clauses to the server where possible. However, the maximum supported value for LIMIT is 1000.

Some tables do not offer support for LIMIT and OFFSET clauses. For these tables and when the global search endpoint is hit, these clauses are evaluated client-side.

You can use ExposeCollectionViews to expose your Box collections as separate views and query the metadata information of their files and folders. The generated view names are prefixed with Collection_.

You can also use AsUserId to expose the collections of a specific user and IncludeCustomFields to expose custom metadata fields as columns on the generated views.

The Cloud models the data in Box as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Box Tables

Name	Description
Bookmarks	Stores and manages bookmarks that reference web links saved within Box, allowing users to create, update, delete, and retrieve them.
Collaborations	Tracks collaboration settings on Box items such as files and folders, including user roles and permissions for shared access.
Comments	Contains user comments made on Box files and folders, supporting creation, retrieval, updates, and deletion.
Folders	Represents folders in Box, including their structure, contents, and metadata, with full create, update, delete, and query capabilities.
Groups	Manages groups of users in Box for easier collaboration and permission assignment across files and folders.
LegalPolicies	Stores legal hold policies created by an enterprise to preserve content for compliance or litigation purposes.
Memberships	Defines user memberships in groups, linking users to groups and managing their access within Box.
MetadataTemplates	Contains reusable metadata templates that define structured fields which can be applied to files and folders.
TaskAssignments	Represents assignments of tasks within Box, linking a task to the users responsible for completing it.
Tasks	Stores tasks created in Box for files and folders, supporting assignment, due dates, and completion tracking.
TrashedItems	Contains items moved to the trash, allowing users to view, query, or permanently delete trashed files and folders.
Users	Stores user account details in Box, supporting creation, management, and retrieval of users across the enterprise.

Stores and manages bookmarks that reference web links saved within Box, allowing users to create, update, delete, and retrieve them.

Table Specific Information

Select

If you query Bookmarks without specifying any condition in the WHERE Clause, only bookmarks up to 5 levels deep from the root folder are returned by default. You can change the default depth value in the connection string (for example, DirectoryRetrievalDepth=10).

SELECT * FROM Bookmarks;

By default, the search starts from the root directory, identified as directory '0'. To customize the starting directory for your search, specify its Id using the SearchRootId column.

SELECT * FROM Bookmarks WHERE SearchRootId = '293533136411';

Retrieve a bookmark by specifying the Id:

SELECT * FROM Bookmarks WHERE Id = '8397822180';

To search all the bookmarks in your enterprise, query the Bookmarks table with the Search Terms column.

SELECT * FROM Bookmarks WHERE SearchTerms = 'CData' AND OwnerUserIds = '311997108,1';

To search all the bookmarks within a specific folder, query the Bookmarks table with the ParentId column.

SELECT * FROM Bookmarks WHERE ParentId = 62297447480;

Note: When using a ParentId filter, avoid specifying a SearchRootId simultaneously. If both are used, the search will recursively start from the specified SearchRootId instead of the ParentId, which may result in slower performance.

If you're authenticated as an administrator with user impersonation permissions, you can query bookmarks from multiple user accounts:

SELECT * FROM Bookmarks WHERE AsUserId IN (SELECT Id FROM Users);

Note: User impersonation has the following limitations:

• The authenticated user cannot be impersonated unless that user is a service account.
• If the authenticated user is a standard user account, they can only query bookmarks associated with their account.
• Bookmarks shared with multiple users are only returned for one of the users.

Insert

To insert a bookmark you must specify at least the URL and ParentId column.

INSERT INTO Bookmarks (Url, Name, Description, ParentId) VALUES ('https://www.cdata.com/', 'CData', 'Visit CData!', 0);

Update

Any column where ReadOnly=False can be updated.

UPDATE Bookmarks SET Name = 'CData Updated Bookmark', ParentId = 62297447480  WHERE Id = 8397822180;

Delete

Delete a bookmark by specifying its Id. This bookmark is then moved to TrashedItems.

DELETE FROM Bookmarks WHERE Id = 8397822180;

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	Unique identifier assigned to the bookmark within Box.
Url	String	False	The web address the bookmark points to, used to link to external resources.
Name	String	False	The display name given to the bookmark.
Description	String	False	A user-provided description of the bookmark's purpose or content.
ParentId	String	False	Identifier of the folder that contains the bookmark, defining its location in Box.
CreatedAt	Datetime	True	The date and time when the bookmark was originally created in Box.
CreatedById	String	True	Identifier of the user who created the bookmark.
CreatedByName	String	True	The full name of the user who created the bookmark.
CreatedByLogin	String	True	The login email of the user who created the bookmark.
ModifiedAt	Datetime	True	The date and time when the bookmark was last updated.
ModifiedById	String	True	Identifier of the user who last modified the bookmark.
ModifiedByName	String	True	The full name of the user who last modified the bookmark.
ModifiedByLogin	String	True	The login email of the user who last modified the bookmark.
OwnedById	String	True	Identifier of the user who owns the bookmark.
OwnedByName	String	True	The full name of the user who owns the bookmark.
OwnedByLogin	String	True	The login email of the user who owns the bookmark.
Etag	String	True	Version identifier for the bookmark used to detect changes and manage concurrency.
SequenceId	String	True	An incremental identifier representing the version sequence of the bookmark.
SharedLink	String	True	A shareable URL generated to provide access to the bookmark.
ItemStatus	String	True	The current state of the bookmark, such as active or trashed.
Path	String	True	The full folder path leading to the bookmark within the Box hierarchy.
AsUserId	String	False	Identifier of the user to impersonate when making API calls, available only for Admin, Co-Admin, and Service Accounts.
SearchRootId	String	True	The folder identifier that defines the starting point for recursive searches, with '0' indicating the root folder.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
SearchTerms	String	Keywords used to search bookmarks stored in Box.
Scope	String	The scope of the search, such as limiting results to a user or enterprise. The allowed values are user_content, enterprise_content.
OwnerUserIDs	String	A list of user identifiers separated by a comma, used to restrict searches to bookmarks owned by specific users.
AncestorFolderIDs	String	A list of folder identifiers separated by a comma, used to restrict searches to bookmarks contained within specific folders.

Tracks collaboration settings on Box items such as files and folders, including user roles and permissions for shared access.

Table Specific Information

Collaborations are connections between Folders and Groups. For example, one Group can collaborate on a specific Folder.

Select

When selecting from the Collaborations table, you must specify Id, FolderId, or GroupId in the WHERE clause.

SELECT * FROM Collaborations WHERE Id = '62696811616';

If you're authenticated as an administrator with user impersonation permissions, you can query collaborations from multiple user accounts.

SELECT * FROM Collaborations WHERE AsUserId IN (SELECT Id FROM Users);

Note: User impersonation has the following limitations:

• The authenticated user cannot be impersonated unless that user is a service account.
• If the authenticated user is a standard user account, they can only query collaborations associated with their account.
• Collaborations shared with multiple users are only returned for one of the users.

Insert

To insert into Collaborations, connect a Folder with a Group or a User and assign a Role to them.

INSERT INTO Collaborations (Role, ItemId, ItemType, AccessibleById, AccessibleByType) VALUES ('admin', '1', 'folder', '2', 'user');

Update

You can only update the Role and Status columns.

UPDATE Collaborations SET Role = 'viewer', Status = 'accepted' WHERE Id = '100';

Delete

Delete a collaboration by specifying its Id:

DELETE FROM Collaborations WHERE Id = '100';

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	Unique identifier assigned to the collaboration record in Box.
CreatedAt	Datetime	True	The date and time when the collaboration was originally created.
ModifiedAt	Datetime	True	The date and time when the collaboration was last updated.
AcknowledgedAt	Datetime	True	The date and time when the invited collaborator acknowledged or accepted the collaboration.
CreatedById	String	True	Identifier of the user who created the collaboration invitation.
Status	String	False	The current state of the collaboration, such as pending, accepted, or rejected.
Role	String	False	The permission level granted to the collaborator. Allowed values are editor, viewer, previewer, uploader, previewer uploader, viewer uploader, co-owner, or owner.
ItemId	String	False	Identifier of the file or folder that the collaboration is associated with.
ItemType	String	False	Specifies whether the collaboration is tied to a file or a folder.
AccessibleById	String	False	Identifier of the user or group that has been granted access through the collaboration.
AccessibleByType	String	False	The type of collaborator entity associated with AccessibleById, such as user or group. The allowed values are group, user.
AccessibleByLogin	String	False	The login email of the user or group associated with AccessibleById.
AsUserId	String	False	Identifier of the user to impersonate for API requests, available only to Admin, Co-Admin, and Service Accounts.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
FolderId	String	Identifier of a folder used to filter collaborations related to that folder.
GroupId	String	Identifier of a group used to filter collaborations related to that group.

Contains user comments made on Box files and folders, supporting creation, retrieval, updates, and deletion.

Table Specific Information

Comments are additional information passed on to a File. These Comments can also have child Comments.

Select

When selecting from the Collaborations table, you must specify the Id or FileId in the WHERE clause.

SELECT * FROM Comments WHERE Id = '1925314736840';

If you're authenticated as an administrator with user impersonation permissions, you can query comments from multiple user accounts.

SELECT * FROM Comments WHERE AsUserId IN (SELECT Id FROM Users);

Note: User impersonation has the following limitations:

• The authenticated user cannot be impersonated unless that user is a service account.
• If the authenticated user is a standard user account, they can only query comments associated with their account.
• Comments shared with multiple users are only returned for one of the users.

Insert

To insert into Comments, specify the item to insert the Comment into, as well as the Message. Either a Message or a TaggedMessage must be specified, but not both.

INSERT INTO Comments (ItemId, ItemType, Message) VALUES ('1', 'file', 'example comment');

Update

You can only update the message of the Comment.

UPDATE Comments SET Message = 'editor' WHERE Id = '100';

Delete

Delete a comment by specifying its Id:

DELETE FROM Comments WHERE Id = '100';

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	Unique identifier assigned to the comment.
Message	String	False	The plain text content of the comment. Either this or TaggedMessage must be used, but not both.
TaggedMessage	String	False	The formatted message of the comment that supports tagging users with @[USER_ID:USERNAME], which notifies the tagged user. An invalid tag format results in an error.
ItemId	String	False	Identifier of the item that the comment is attached to, such as a file or another comment.
ItemType	String	False	Specifies the type of item the comment is associated with, which can be a file or another comment. The allowed values are file, comment.
CreatedById	String	True	Identifier of the user who authored the comment.
CreatedByName	String	True	The full name of the user who authored the comment.
CreatedByLogin	String	True	The login email of the user who authored the comment.
CreatedAt	Datetime	True	The date and time when the comment was created.
AsUserId	String	False	Identifier of the user to impersonate for API calls, available only for Admin, Co-Admin, and Service Accounts.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
FileID	String	Identifier of the file the comment is linked to. This field is only for querying and cannot be used when inserting comments.

Represents files stored in Box, including their content, metadata, ownership, and lifecycle information.

Table Specific Information

Select

If you query Files without specifying any condition in the WHERE Clause, only files up to 5 levels deep from the root folder are returned by default. You can change the default depth value in the connection string (for example, DirectoryRetrievalDepth=10).

SELECT * FROM Files;

By default, the search starts from the root directory, identified as directory '0'. To customize the starting directory for your search, specify its Id using the SearchRootId column.

SELECT * FROM Files WHERE SearchRootId = '293533136411';

To search all the Files in your enterprise, query the Files table with the SearchTerms column.

SELECT * FROM Files WHERE SearchTerms = 'untitled';

To search all the Files within a specific folder, query the Files table with a filter on the relevant folder's Id in the ParentId column.

SELECT * FROM Files WHERE ParentId = '12';

Note: When using a ParentId filter, avoid specifying a SearchRootId simultaneously. If both are used, the search will recursively start from the specified SearchRootId instead of the ParentId, which may result in slower performance.

Update

Any column where ReadOnly=False can be updated.

UPDATE Files SET Description = 'example description', Sharedlink = 'http://sharedlink.com', OwnedbyId = '321', ParentId = '12', Name = 'updated file name' WHERE Id = '123';

Delete

Delete a file by specifying its Id. This file is then moved to TrashedItems.

DELETE FROM Files WHERE Id = '100';

Columns

Name	Type	ReadOnly	Description
SearchTerms	String	True	Keywords used to search for files stored in Box.
Id [KEY]	String	True	Unique identifier assigned to the file.
Name	String	False	The display name of the file.
Sha1	String	False	The SHA-1 checksum of the file, used for content verification and deduplication.
Etag	String	False	Version identifier for the file, used to track changes and manage concurrency.
SequenceId	String	False	An incremental identifier representing the version sequence of the file.
Description	String	False	A user-provided description that explains the file's purpose or contents.
Size	Integer	True	The file size in bytes.
CreatedAt	Datetime	True	The date and time when the file was originally created in Box.
ModifiedAt	Datetime	True	The date and time when the file was last updated in Box.
TrashedAt	Datetime	True	The date and time when the file was moved to the trash.
PurgedAt	Datetime	True	The date and time when the file was permanently deleted from the trash.
ContentCreatedAt	Datetime	True	The date and time when the file content was first created, which may differ from the Box creation date.
ContentModifiedAt	Datetime	True	The date and time when the file content itself was last modified.
CreatedById	String	True	Identifier of the user who created the file.
CreatedByName	String	True	The full name of the user who created the file.
CreatedByLogin	String	True	The login email of the user who created the file.
SharedLink	String	False	A shareable URL that provides access to the file.
ModifiedById	String	True	Identifier of the user who most recently modified the file.
ModifiedByName	String	True	The full name of the user who most recently modified the file.
ModifiedByLogin	String	True	The login email of the user who most recently modified the file.
OwnedById	String	False	Identifier of the user who owns the file.
OwnedByName	String	False	The full name of the user who owns the file.
OwnedByLogin	String	False	The login email of the user who owns the file.
ParentId	String	False	Identifier of the folder that contains the file.
ItemStatus	String	False	The current state of the file, such as active or trashed.
Path	String	True	The full folder path leading to the file within the Box hierarchy.
SearchRootId	String	True	Identifier of the folder to use as the starting point for recursive searches, with '0' representing the root folder.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Scope	String	The scope of the file search, such as limiting results to a user or enterprise.
FileExtension	String	The file's extension, such as PDF or DOCX.
ContentTypes	String	Specifies which file fields to search against, separated by commas. Possible values include name, file_content, description, comments, and tags.
OwnerUserIDs	String	A list of user identifiers separated by a comma, used to restrict searches to files owned by specific users.
AncestorfolderIDs	String	A list of folder identifiers separated by a comma, used to restrict searches to files contained within specific folders.
AsUserId	String	Identifier of the user to impersonate for API requests, available only for Admin, Co-Admin, and Service Accounts.

Represents folders in Box, including their structure, contents, and metadata, with full create, update, delete, and query capabilities.

Table Specific Information

Select

If you query Folders without specifying any condition in the WHERE Clause, only files up to 5 levels deep from the root folder are returned by default. You can change the default depth value in the connection string; e.g. DirectoryRetrievalDepth=10.

SELECT * FROM Folders;

By default, the search starts from the root directory, identified as directory '0'. To customize the starting directory for your search, specify its Id using the SearchRootId column.

SELECT * FROM Folders WHERE SearchRootId = '293533136411';

To search all the Folders in your enterprise, query the Folders table with the SearchTerms column.

SELECT * FROM Folders WHERE SearchTerms = 'untitled';

To search all the Folders within a specific folder, query the Folders table with the ParentId column.

SELECT * FROM Folders WHERE ParentId = '12';

Note: When using a ParentId filter, avoid specifying a SearchRootId simultaneously. If both are used, the search will recursively start from the specified SearchRootId instead of the ParentId, which may result in slower performance.

If you're authenticated as an administrator with user impersonation permissions, you can query folders from multiple user accounts:

SELECT * FROM Folders WHERE AsUserId IN (SELECT Id FROM Users);

Note: User impersonation has the following limitations:

• The authenticated user cannot be impersonated unless that user is a service account.
• If the authenticated user is a standard user account, they can only query folders associated with their account.
• Folders shared with multiple users are only returned for one of the users.

Insert

You must specify the name of the Folder and also the Id of the parent Folder. Use 0 for the root Folder's ParentId.

INSERT INTO Folders (Name, ParentId, SharedLink, Description, Access, OwnedById) VALUES ('new folder', '0', 'http://sharedlink.com', 'example desc', 'open', '123');

Update

Any column where ReadOnly=False can be updated.

UPDATE Folders SET Description = 'example description', Access = 'open', SharedLink = 'http://sharedlink.com', OwnedById = '321', ParentId = '12', Name = 'no longer new folder'  WHERE Id = '123';

Delete

Delete a folder by specifying its Id:

DELETE FROM Folders WHERE Id = '123';

Columns

Name	Type	ReadOnly	Description
SearchTerms	String	True	Keywords used to search for folders stored in Box.
Id [KEY]	String	True	Unique identifier assigned to the folder.
Name	String	False	The display name of the folder.
Etag	String	True	Version identifier for the folder, used to detect changes and manage concurrency.
SequenceId	String	True	An incremental identifier representing the version sequence of the folder.
Description	String	False	A user-provided description that explains the purpose or contents of the folder.
Access	String	False	The email addresses of users who have been granted access to the folder. The allowed values are open, collaborators.
Size	Integer	True	The total size of the folder contents, measured in bytes.
CreatedAt	Datetime	True	The date and time when the folder was originally created in Box.
ModifiedAt	Datetime	True	The date and time when the folder's metadata or contents were last updated.
TrashedAt	Datetime	True	The date and time when the folder was moved to the trash.
PurgedAt	Datetime	True	The date and time when the folder was permanently deleted from the trash.
ContentCreatedAt	Datetime	True	The date and time when the first content item inside the folder was created.
ContentModifiedAt	Datetime	True	The date and time when the most recent content inside the folder was modified.
CreatedBy	String	True	Identifier of the user who created the folder.
CreatedByName	String	True	The full name of the user who created the folder.
CreatedByLogin	String	True	The login email of the user who created the folder.
SharedLink	String	False	A shareable URL that provides access to the folder.
ModifiedBy	String	True	Identifier of the user who last modified the folder.
ModifiedByName	String	True	The full name of the user who last modified the folder.
ModifiedByLogin	String	True	The login email of the user who last modified the folder.
OwnedById	String	False	Identifier of the user who owns the folder.
OwnedByName	String	True	The full name of the user who owns the folder.
OwnedByLogin	String	True	The login email of the user who owns the folder.
ParentId	String	False	Identifier of the parent folder that contains this folder.
ItemStatus	String	True	The current state of the folder, such as active or trashed.
Path	String	True	The full folder path leading to the folder within the Box hierarchy.
AsUserId	String	False	Identifier of the user to impersonate for API requests, available only for Admin, Co-Admin, and Service Accounts.
SearchRootId	String	True	Identifier of the folder to use as the starting point for recursive searches, with '0' representing the root folder.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Scope	String	The scope of the folder search, such as limiting results to a user or enterprise.
ContentTypes	String	Specifies which folder-related fields to search against, separated by commas. Possible values include name, file_content, description, comments, and tags.
OwnerUserIDs	String	A list of user identifiers separated by a comma, used to restrict searches to folders owned by specific users.
AncestorfolderIDs	String	A list of folder identifiers separated by a comma, used to restrict searches to folders contained within specific parent folders.

Manages groups of users in Box for easier collaboration and permission assignment across files and folders.

Table Specific Information

Select

You can retrieve all the Groups or filter them by Id.

SELECT * FROM Groups;

If you're authenticated as an administrator with user impersonation permissions, you can query groups from multiple user accounts:

SELECT * FROM Groups WHERE AsUserId IN (SELECT Id FROM Users);

Note: User impersonation has the following limitations:

• The authenticated user cannot be impersonated unless that user is a service account.
• If the authenticated user is a standard user account, they can only query groups associated with their account.
• Groups shared with multiple users are only returned for one of the users.

Insert

Only the Name column is required to create a Group.

INSERT INTO Groups (Name, Provenance, MemberViewabilityLevel) VALUES ('new group', 'google', 'admins_only');

Update

Any column where ReadOnly=False can be updated.

UPDATE Groups SET InvitabilityLevel = 'admins_and_members' WHERE Id = '111';

Delete

Delete a group by specifying its Id:

DELETE FROM Groups WHERE Id = '111';

Columns

Name	Type	ReadOnly	Description
ID [KEY]	String	True	Unique identifier assigned to the group.
Name	String	False	The display name of the group.
Provenance	String	False	Tracks the external system or source from which the group originated, often used for integration purposes.
ExternalSyncIdentifier	String	False	An identifier used to map the group to an external system when groups are synchronized from outside sources.
Description	String	False	A user-provided description that explains the purpose or membership of the group.
InvitabilityLevel	String	False	Defines who is allowed to invite this group to collaborate on folders, such as admins only or all group members.
MemberViewabilityLevel	String	False	Defines who is allowed to view the membership of the group, such as only admins or all collaborators.
CreatedAt	Datetime	True	The date and time when the group was originally created. An Id must be specified to retrieve this field.
ModifiedAt	Datetime	True	The date and time when the group's details were last updated. An Id must be specified to retrieve this field.
AsUserId	String	False	Identifier of the user to impersonate for API requests, available only for Admin, Co-Admin, and Service Accounts.

Stores legal hold policies created by an enterprise to preserve content for compliance or litigation purposes.

Table Specific Information

Note: The Legal Hold feature must be enabled for a Box enterprise account to query this table. To add this feature, please visit Box Governance and Compliance.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Unique identifier assigned to the legal hold policy.
AssignmentFileCount	Integer	True	The number of files currently under this legal hold policy.
AssignmentFileVersionCount	Integer	True	The number of file versions assigned to this legal hold policy.
AssignmentFolderCount	Integer	True	The number of folders covered by this legal hold policy.
AssignmentUserCount	Integer	True	The number of users assigned to this legal hold policy.
CreatedAt	Datetime	True	The date and time when the legal hold policy was created.
CreatedById	String	True	Identifier of the user who created the legal hold policy.
CreatedByLogin	String	True	The login email of the user who created the legal hold policy.
CreatedByName	String	True	The full name of the user who created the legal hold policy.
CreatedByType	String	True	Specifies the type of user or account that created the policy, such as a user or service account.
DeletedAt	Datetime	True	The date and time when the legal hold policy was deleted, if applicable.
Description	String	False	A user-provided description of the legal hold policy and its intended purpose.
FilterEndedAt	Datetime	False	The end date and time of the policy's filter criteria, used to define the retention window.
FilterStartedAt	Datetime	False	The start date and time of the policy's filter criteria, used to define the retention window.
ModifiedAt	Datetime	True	The date and time when the legal hold policy was last updated.
PolicyName	String	False	The display name of the legal hold policy.
ReleaseNotes	String	False	Notes provided when the policy was released, describing the reason or details of the release.
Status	String	True	The current state of the policy, such as active or released.
Type	String	True	Specifies the type of policy, such as legal hold or another retention category.
AsUserId	String	False	Identifier of the user to impersonate for API requests, available only for Admin, Co-Admin, and Service Accounts.
IsOngoing	Boolean	False	Indicates whether the policy should continue applying to new assignments created after its initialization.

Defines user memberships in groups, linking users to groups and managing their access within Box.

Table Specific Information

Memberships are the relations between a User and a Group.

Select

When selecting from the Memberships table, you must specify Id, GroupId, or UserId in the WHERE clause.

SELECT * FROM Memberships WHERE Id = '24201762883';

If you're authenticated as an administrator with user impersonation permissions, you can query memberships from multiple user accounts. For example:

SELECT * FROM Memberships WHERE AsUserId IN (SELECT Id FROM Users);

Note: User impersonation has the following limitations:

• The authenticated user cannot be impersonated unless that user is a service account.
• If the authenticated user is a standard user account, they can only query memberships associated with their account.
• Memberships shared with multiple users are only returned for one of the users.

Insert

To insert into Memberships, connect a Group (GroupId) with a User (UserId).

INSERT INTO Memberships (GroupId, UserId) VALUES (1001, 123);

Update

You can only update the role of Memberships. The default role is 'memberships' with the option for 'admin'.

UPDATE Memberships SET Role = 'admin' WHERE Id = '100';

Delete

Delete a membership by specifying its Id:

DELETE FROM Memberships  WHERE Id = '100'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	Unique identifier assigned to the membership record.
Role	String	False	The role granted to the user within the group, such as member or admin.
CreatedAt	Datetime	True	The date and time when the membership was created. Requires an Id to retrieve this field.
ModifiedAt	Datetime	True	The date and time when the membership was last updated. Requires an Id to retrieve this field.
UserName	String	True	The full name of the user who is part of the membership.
UserLogin	String	True	The login email of the user who is part of the membership.
UserId	String	False	Identifier of the user associated with the membership.
GroupName	String	False	The display name of the group that the membership belongs to.
GroupId	String	False	Identifier of the group that the membership is associated with.
AsUserId	String	False	Identifier of the user to impersonate for API requests, available only for Admin, Co-Admin, and Service Accounts.

Contains reusable metadata templates that define structured fields which can be applied to files and folders.

Table Specific Information

Select

You can retrieve information about the Metadata Template.

SELECT * FROM MetadataTemplates;

You can also retrieve the information of any Template in your enterprise:

SELECT * FROM MetadataTemplates WHERE Id = 'e93746cc-03f6-4dee-ab45-01834989950c';

Insert

You can insert Metadata Template for your enterprise.

Insert a single field to the Template.

INSERT INTO MetadataTemplates (DisplayName, Scope, FieldsDisplayName, FieldsType) VALUES ('TestTemplate', 'enterprise', 'TestField', 'string');

Insert multiple fields to the Template.

INSERT INTO MetadataFields#TEMP (FieldDisplayName, FieldType, FieldOptions) VALUES ('Industry', 'enum', 'Technology, HealthCare');
INSERT INTO MetadataFields#TEMP (FieldDisplayName, FieldType) VALUES ('Contact Role', 'string');

INSERT INTO MetadataTemplates (DisplayName, Scope, FieldsAggregate) VALUES ('TestTemplate', 'enterprise', 'MetadataFields#TEMP');

Update

Add field to the existing Template.

UPDATE MetadataTemplates SET Op = 'addField', FieldsKey = 'category', FieldsDisplayName = 'Category', FieldsisHidden = false, FieldsType = 'string' WHERE Scope = 'enterprise' AND TemplateKey = 'TestTemplate';

Update Fields in the Template.

UPDATE MetadataTemplates SET Op = 'editField', FieldsKey = 'Category', FieldsDescription = 'The Product Category' WHERE Scope = 'enterprise' AND TemplateKey = 'TestTemplate';

Reorder Fields in the Template.

UPDATE MetadataTemplates SET Op = 'reorderFields', FieldsKey = 'Category,Industry,Contact' WHERE Scope = 'enterprise' AND TemplateKey = 'TestTemplate';

Remove Fields from the Template.

UPDATE MetadataTemplates SET Op = 'removeField', FieldsKey = 'Industry' WHERE Scope = 'enterprise' AND TemplateKey = 'TestTemplate';

Add Enum Options to the EnumField.

UPDATE MetadataTemplates SET Op = 'addEnumOption', FieldsKey = 'Industry', EnumOptionKey = 'AL' WHERE Scope = 'enterprise' AND TemplateKey = 'TestTemplate';

Reorder Enum Options in the EnumField.

UPDATE MetadataTemplates SET Op = 'reorderEnumOptions', FieldsKey = 'industry', EnumOptionKey = 'AL,AK,AR,N/A' WHERE Scope = 'enterprise' AND TemplateKey = 'TestTemplate';

Update Enum Options in the EnumField. Specify Present value, New value in the EnumOption column, separated with comma.

UPDATE MetadataTemplates SET Op = 'editEnumOption', FieldsKey = 'industry', EnumOptionKey = 'N/A,Outside USA' WHERE Scope = 'enterprise' AND TemplateKey = 'TestTemplate';

Remove Enum Options from the EnumField.

UPDATE MetadataTemplates SET Op = 'removeEnumOption', FieldsKey = 'industry', EnumOptionKey = 'Outside USA' WHERE Scope = 'enterprise' AND TemplateKey = 'TestTemplate';

Delete

Delete metadata templates by specifying Scope and TemplateKey.

DELETE FROM MetadataTemplates WHERE Scope = 'enterprise' AND TemplateKey = 'TestTemplate';

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	Unique identifier assigned to the metadata template.
TemplateKey	String	False	A unique key that identifies the metadata template within the enterprise. This key is unique inside a single enterprise but might differ across enterprises.
CopyInstanceOnItemCopy	Boolean	False	Indicates whether metadata applied to a file or folder should be copied when the item itself is copied.
DisplayName	String	False	The user-friendly name of the metadata template as shown in the Box web and mobile apps.
FieldsId [KEY]	String	True	Unique identifier assigned to a specific field within the metadata template.
FieldsKey	String	False	A unique key for the field within its metadata template, required to distinguish it from other fields.
FieldsDisplayName	String	False	The display name of the field as shown to users in the Box web and mobile apps.
FieldsType	String	False	The type of the metadata field, such as string, enum, or multiSelect.
FieldsDescription	String	False	A description of the metadata field's purpose or usage.
FieldsisHidden	Boolean	False	Indicates whether the field is hidden in the user interface and can only be set programmatically through the API.
FieldsOptions	String	False	A list of allowed options for the field, used with enum and multiSelect field types.
TemplateisHidden	Boolean	False	Indicates whether the template is visible in the Box web application or restricted to API usage only.
Scope	String	False	Defines the scope of the template, such as enterprise-wide or global.
Type	String	True	The object type for the template. This value is always metadata_template.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Op	String	Specifies the type of change to apply to the template, such as add or remove. Some changes might alter existing templates and should be used with caution. The allowed values are editTemplate, addField, reorderFields, addEnumOption, reorderEnumOptions, reorderMultiSelectOptions, addMultiSelectOption, editField, removeField, editEnumOption, removeEnumOption, editMultiSelectOption, removeMultiSelectOption.
EnumOptionKey	String	Used in update operations to define the keys of the enum options that are affected.
MultiSelectOptionKey	String	Used in update operations to define the keys of the multi-select options that are affected.
FieldsAggregate	String	Allows inserting multiple fields into a template at once. Accepted columns include FieldsDisplayName, FieldsType, FieldsDescription, FieldsKey, FieldsisHidden, and FieldsOptions.

Represents assignments of tasks within Box, linking a task to the users responsible for completing it.

Table Specific Information

Task Assignments are Tasks assigned to a specific User.

Select

When selecting from the Task Assignments table, you must specify Id or TaskId in the WHERE clause.

SELECT * FROM TaskAssignments WHERE Id = '35991959268';

If you're authenticated as an administrator with user impersonation permissions, you can query task assignments from multiple user accounts. For example:

SELECT * FROM TaskAssignments WHERE AsUserId IN (SELECT Id FROM Users);

Note: User impersonation has the following limitations:

• The authenticated user cannot be impersonated unless that user is a service account.
• If the authenticated user is a standard user account, they can only query task assignments associated with their account.
• Task assignments shared with multiple users are only returned for one of the users.

Insert

To insert into Task Assignments, connect a Task (TaskId) with a User (AssignedToId).

INSERT INTO TaskAssignments (TaskId, AssignedToId) VALUES (1001, 123);

Update

You can only update the Message of the Task Assignment or its ResolutionState.

UPDATE TaskAssignments SET Message = 'x', ResolutionState = 'completed' WHERE Id = '111';

Delete

Delete task assignments by specifying its Id:

DELETE FROM TaskAssignments WHERE Id = '111';

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	Unique identifier assigned to the task assignment.
TaskId	String	False	Identifier of the task that is being assigned.
AssignedToId	String	False	Identifier of the user who has been assigned to complete the task.
AssignedToName	String	False	The full name of the user who has been assigned the task.
AssignedToLogin	String	False	The login email of the user who has been assigned the task.
ItemType	String	False	Specifies the type of item associated with the task assignment, such as a file or folder.
ItemId	String	False	Identifier of the item associated with the task assignment.
ItemName	String	False	The display name of the item associated with the task assignment.
Message	String	False	The note or instructions attached to the task assignment.
AssignedById	String	False	Identifier of the user who created and assigned the task.
AssignedByName	String	False	The full name of the user who created and assigned the task.
AssignedByLogin	String	False	The login email of the user who created and assigned the task.
AssignedAt	Datetime	True	The date and time when the task was assigned.
RemindedAt	Datetime	True	The date and time when a reminder for the task was sent.
CompletedAt	Datetime	True	The date and time when the task was marked as completed.
ResolutionState	String	False	The current status of the task assignment, indicating whether it has been addressed or remains unresolved. The allowed values are completed, incomplete, approved, rejected.
AsUserId	String	False	Identifier of the user to impersonate for API requests, available only for Admin, Co-Admin, and Service Accounts.

Stores tasks created in Box for files and folders, supporting assignment, due dates, and completion tracking.

Table Specific Information

Tasks are jobs that are waiting to be assigned to someone. These tasks are related to an item, which generally is a File.

Select

When selecting from the Tasks table, you must specify Id or ItemId in the WHERE clause.

SELECT * FROM Tasks WHERE ItemId = '1925314736840';

If you're authenticated as an administrator with user impersonation permissions, you can query tasks from multiple user accounts.

SELECT * FROM Tasks WHERE AsUserId IN (SELECT Id FROM Users);

Note: User impersonation has the following limitations:

• The authenticated user cannot be impersonated unless that user is a service account.
• If the authenticated user is a standard user account, they can only query tasks associated with their account.
• Tasks shared with multiple users are only returned for one of the users.

Insert

ItemId is required to insert into Tasks table. Currently, Box API supports only file as type of the item the task is for.

INSERT INTO Tasks (ItemId, ItemType, Action, Message) VALUES (1001, 'file', 'review', 'message');

Update

The Message is required to perform an UPDATE to a specific task. Also, the Action and DueAt columns can be updated as well. The Action column is only able to take a 'review' value.

UPDATE Tasks SET Message = 'updated message', Action = 'review', DueAt = '2016-05-14' WHERE ID = '100'; 

Delete

Delete a task by specifying its Id:

DELETE FROM Tasks WHERE Id = '100';

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	Unique identifier assigned to the task.
DueAt	Datetime	False	The date and time when the task is due for completion.
ItemId	String	False	Identifier of the item the task is associated with, such as a file or folder.
ItemType	String	False	Specifies the type of item the task is linked to, such as a file or folder.
Action	String	False	The required action for the task assignee, such as reviewing, approving, or completing an item.
Message	String	False	An optional message or instruction included with the task to provide context for the assignee.
CreatedAt	Datetime	True	The date and time when the task was created.
CreatedById	String	True	Identifier of the user who created the task.
CreatedByName	String	True	The full name of the user who created the task.
CreatedByLogin	String	True	The login email of the user who created the task.
IsCompleted	Boolean	False	Indicates whether the task has been marked as completed.
AsUserId	String	False	Identifier of the user to impersonate for API requests, available only for Admin, Co-Admin, and Service Accounts.

Contains items moved to the trash, allowing users to view, query, or permanently delete trashed files and folders.

Table Specific Information

Trashed Items are Files and Folders that have been deleted. This table supports only two operations: Select and Delete. Deleting from this table permanently deletes the File and is not recoverable.

Select

To search in the Trashed Items table for a specific item, specify the type of item (File, Folder, or WEB_LINK).

SELECT * FROM TrashedItems WHERE SearchTerms = 'Untitled' AND Type = 'file';

To query a single-deleted Folder, you can execute a query like the following:

SELECT * FROM TrashedItems WHERE Id = '123' AND Type = 'folder';

To query a single-deleted WEB_LINK, you can execute a query like the following:

SELECT * FROM TrashedItems WHERE Id = '123' AND Type = 'web_link';

Delete

Delete trashed items by specifying the Id and the Type of item.

DELETE FROM TrashedItems WHERE Id = 'abc123' AND Type = 'file';

Columns

Name	Type	ReadOnly	Description
SearchTerms	String	False	A query string used to search across trashed items.
Id [KEY]	String	False	The unique identifier of the trashed item.
Name	String	False	The name of the trashed item.
Type	String	False	The type of trashed item, such as file, folder, or web_link.
Sha1	String	False	The SHA-1 hash of the trashed item for file integrity verification.
Etag	String	False	The entity tag of the trashed item used for version control.
SequenceId	String	False	The sequence Id of the trashed item, used for internal ordering and version tracking.
Description	String	False	The description or notes about the trashed item.
Size	Int64	False	The size of the trashed item in bytes.
CreatedAt	Datetime	False	The date and time when the trashed item was originally created.
ModifiedAt	Datetime	False	The date and time when the trashed item was last modified.
TrashedAt	Datetime	False	The date and time when the item was moved to the trash.
PurgedAt	Datetime	False	The date and time when the item was permanently deleted from the trash.
ContentCreatedAt	Datetime	False	The date and time when the content of the item was originally created.
ContentModifiedAt	Datetime	False	The date and time when the content of the item was last modified.
CreatedById	String	False	The Id of the user who created the trashed item.
CreatedByName	String	False	The name of the user who created the trashed item.
CreatedByLogin	String	False	The login of the user who created the trashed item.
SharedLink	String	False	The shared link associated with the trashed item, if one exists.
ModifiedBy	String	False	The Id of the user who last modified the trashed item.
ModifiedByName	String	False	The name of the user who last modified the trashed item.
ModifiedByLogin	String	False	The login of the user who last modified the trashed item.
OwnedById	String	False	The Id of the user who owns the trashed item.
OwnedByName	String	False	The name of the user who owns the trashed item.
OwnedByLogin	String	False	The login of the user who owns the trashed item.
ParentId	String	False	The Id of the parent folder containing the trashed item.
ItemStatus	String	False	The current status of the trashed item, such as active, trashed, or purged.
AsUserId	String	False	The Id of the user you want to impersonate. Only works with Admin, Co-Admin, and Service Accounts.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Scope	String	Defines the scope of the search, such as enterprise or user-specific.
FileExtension	String	The file extension of the trashed item, if applicable.
SearchContent	String	Specifies which parts of the item to search (such as name, description, or content), separated by commas.

Stores user account details in Box, supporting creation, management, and retrieval of users across the enterprise.

Table Specific Information

Note: Authenticated users must have permission to look up users in the entire Box enterprise.

Select

You can retrieve information about the current User, a User in your enterprise specified by Id, or all the Users in the enterprise.

SELECT * FROM Users;

You can also retrieve the information of any User who is in your enterprise:

SELECT * FROM Users WHERE Id = '1';

If you're authenticated as an administrator with user impersonation permissions, you can query users from multiple user accounts:

SELECT * FROM Users WHERE AsUserId IN (SELECT Id FROM Users);

Note: User impersonation has the following limitations:

• The authenticated user cannot be impersonated unless that user is a service account.
• If the authenticated user is a standard user account, they can only query users associated with their account.
• Users shared with multiple users are only returned for one of the users.

Insert

You can invite a User to your enterprise. The following query will send an invitation email to join your enterprise:

INSERT INTO Users (Login, Name, Role) VALUES ('[email protected]', 'Username', 'coadmin');

Update

Any column where ReadOnly=False can be updated.

UPDATE Users SET Name = 'Test', Role = 'user', IsExemptFromDeviceLimits = false WHERE Id = '111';

Delete

Delete users by specifying its Id:

DELETE FROM Users WHERE Id = '111'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	Unique identifier assigned to the user. When querying, this can be set to the value 'me' to return details for the currently authenticated user.
Login	String	False	The login email address of the user.
Name	String	False	The full display name of the user.
EnterpriseId	String	False	Identifier of the enterprise the user belongs to. Can be set to null to disassociate the user from the enterprise.
Role	String	False	The user's role within the enterprise, such as admin, co-admin, or user.
Language	String	False	The preferred language setting for the user interface.
IsPlatformAccessOnly	Boolean	False	Indicates whether the account is a Box app user without full standard access.
IsSyncEnabled	Boolean	False	Indicates whether the user is allowed to use Box Sync for offline file access.
JobTitle	String	False	The job title provided for the user.
Phone	String	False	The phone number associated with the user.
Address	String	False	The mailing address of the user.
SpaceAmount	Long	False	The total storage space allocated to the user, measured in bytes.
SpaceUsed	Long	False	The amount of storage space the user has consumed, measured in bytes.
MaxUploadSize	Long	False	The maximum file size the user is allowed to upload, measured in bytes.
TrackingCodes	String	False	Custom tracking codes associated with the user, separated by commas.
CanSeeManagedUsers	Boolean	False	Indicates whether the user has permission to view other managed users in the enterprise.
TimeZone	String	False	The preferred time zone setting for the user.
IsExemptFromDeviceLimits	Boolean	False	Indicates whether the user is exempt from restrictions on the number of devices linked to their account.
IsExemptFromLoginVerification	Boolean	False	Indicates whether the user is exempt from login verification requirements, such as two-step authentication.
Status	String	False	The current status of the user account, such as active, inactive, or deleted.
IsPasswordResetRequired	Boolean	False	Indicates whether the user must reset their password on the next login.
CreatedAt	Datetime	True	The date and time when the user account was created.
ModifiedAt	Datetime	True	The date and time when the user account was last updated.
AsUserId	String	False	Identifier of the user to impersonate for API requests, available only for Admin, Co-Admin, and Service Accounts.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Box Views

Name	Description
Collections	Displays collections of items that users have grouped together in Box for easier navigation and organization.
FileMetadataInstances	Retrieves metadata applied to specific files, showing key-value fields associated with metadata templates.
FileVersions	Lists all available versions of a file stored in Box, enabling tracking of file history and access to prior revisions.
RecentItems	Shows a list of items recently accessed by the user, such as files and folders opened in Box.
SharedItems	Retrieves items that have been shared, including their shared links and associated access permissions.
SignRequests	Lists electronic signature requests sent or received through Box Sign, including request status.
UserEvents	Provides a record of user activity events in Box, such as logins, file uploads, shares, and collaborations.

Displays collections of items that users have grouped together in Box for easier navigation and organization.

Columns

Name	Type	Description
Id	String	Unique identifier assigned to the collection.
Name	String	The display name of the collection.
Type	String	Specifies the object type of the collection, such as collection.
CollectionType	String	Defines the subtype of the collection, which determines how it is visually presented in Box, such as favorites or recently accessed.

Retrieves metadata applied to specific files, showing key-value fields associated with metadata templates.

Select

To select from the File Metadata Instances view, you must specify FileID, or FileID and Scope and Template in the WHERE clause. For example:

SELECT * FROM FileMetadataInstances WHERE FileId = '1723610396614';

Columns

Name	Type	Description
Id	String	A universally unique identifier (UUID) assigned to the metadata instance.
FileId [KEY]	String	Identifier of the file to which the metadata instance is attached.
Template	String	The name of the metadata template applied to the file.
Parent	String	Identifier of the parent item the metadata instance is attached to, formatted as {type}_{id} to combine item type and identifier.
Scope	String	Specifies the scope in which the metadata template is applied. This can be enterprise_{enterprise_id} for enterprise-specific templates or global for templates available across all enterprises.
Version	String	The version number of the metadata instance, starting at 0 and incrementing each time a user-defined property is updated.
CanEdit	String	Indicates whether the current user has permission to edit this metadata instance.
Type	String	The object type identifier for the metadata instance.
TypeVersion	String	The version of the metadata template definition that was last applied to this instance.
UserDefinedFieldName	String	The name of a user-defined field included in the metadata template.
UserDefinedFieldValue	String	The value assigned to a user-defined field in the metadata template.

Lists all available versions of a file stored in Box, enabling tracking of file history and access to prior revisions.

Table Specific Information

File Versions contains information about older versions of a file. This table supports only the SELECT operation.

Select

When selecting from the File Versions view, you must specify FileId, or FileId and Id in the WHERE clause.

SELECT * FROM FileVersions WHERE FileId = '1926408231807';

If you're authenticated as an administrator with user impersonation permissions, you can query file versions from multiple user accounts. For example:

SELECT * FROM FileVersions WHERE AsUserId IN (SELECT Id FROM Users);

Note: User impersonation has the following limitations:

• The authenticated user cannot be impersonated unless that user is a service account.
• If the authenticated user is a standard user account, they can only query file versions associated with their account.
• File versions shared with multiple users are only returned for one of the users.

Columns

Name	Type	Description
Id [KEY]	String	The unique identifier of the file version, used to distinguish between different saved versions of the same file.
FileId	String	The unique identifier of the parent file that this version belongs to.
CreatedAt	Datetime	The timestamp when this version of the file was created. For example, '2023-01-15T10:45:00Z'.
ModifiedAt	Datetime	The timestamp when this version of the file was last modified.
ModifiedById	String	The Id of the user who last modified this file version.
ModifiedByName	String	The display name of the user who last modified this file version.
ModifiedByLogin	String	The login (usually email) of the user who last modified this file version.
ModifiedByType	String	The type of the user who last modified the file version, such as 'user' or 'service_account'.
Name	String	The name of the file associated with this version, including extension (for example, 'Report_Q1.pdf').
PurgedAt	Datetime	The timestamp when this file version was permanently deleted (purged).
RestoredAt	Datetime	The timestamp when this version of the file was restored.
RestoredById	String	The Id of the user who restored this file version.
RestoredByLogin	String	The login (usually email) of the user who restored this file version.
RestoredByName	String	The display name of the user who restored this file version.
RestoredByType	String	The type of the user who restored the file version, such as 'user' or 'service_account'.
Sha1	String	The SHA-1 checksum of the file version, used to verify file integrity.
Size	Int64	The size of the file version in bytes. For example, '204800' represents a 200 KB file.
TrashedAt	Datetime	The timestamp when this file version was moved to the trash.
TrashedById	String	The Id of the user who moved this file version to the trash.
TrashedByLogin	String	The login (usually email) of the user who moved this file version to the trash.
TrashedByName	String	The display name of the user who moved this file version to the trash.
TrashedByType	String	The type of the user who moved the file version to the trash, such as 'user' or 'service_account'.
Type	String	The item type, which is always 'file_version'.
AsUserId	String	The Id of the user you want to impersonate. Only works with Admin, Co-Admin, and Service Accounts.

Shows a list of items recently accessed by the user, such as files and folders opened in Box.

Columns

Name	Type	Description
Type	String	The type of recent item, such as file, folder, or web link.
InteractedAt	Datetime	The timestamp of the most recent interaction with the item.
InteractionSharedLink	String	The shared link used to access the item, if applicable; otherwise null.
InteractionType	String	The type of action most recently taken on the item, such as preview, edit, or download.
ItemId	String	The unique identifier for the recent item.

Retrieves items that have been shared, including their shared links and associated access permissions.

Table Specific Information

Shared Items are Files that are open to public viewing by using a URL. These files can also be password protected. Anyone who has access to this URL and password can read/write to the file.

Select

To select from the Shared Items view, specify the SharedLink column that points to the item.

SELECT * FROM SharedItems WHERE SharedLink = 'https://app.box.co/s/abcdef123456';

If the SharedItem has a password, specify the password as well.

SELECT * FROM SharedItems WHERE SharedLink = 'www.url.com' AND SharedLinkPassword = 'password';

If you're authenticated as an administrator with user impersonation permissions, you can query shared items from multiple user accounts. For example:

SELECT * FROM SharedItems WHERE AsUserId IN (SELECT Id FROM Users);

Note: User impersonation has the following limitations:

• The authenticated user cannot be impersonated unless that user is a service account.
• If the authenticated user is a standard user account, they can only query shared items associated with their account.
• Shared items shared with multiple users are only returned for one of the users.

Columns

Name	Type	Description
Name	String	The name of the shared item.
ItemId [KEY]	String	The unique identifier of the shared item.
ItemType	String	The type of shared item, such as file, folder, or web link.
CreatedAt	String	The date and time when the shared item was created.
Description	String	The description of the shared item.
ModifiedAt	String	The date and time when the shared item was last modified.
OwnedById	String	The Id of the user who owns the shared item.
OwnedByName	String	The name of the user who owns the shared item.
OwnedByLogin	String	The login (email) of the user who owns the shared item.
ParentId	String	The Id of the parent folder or container of the shared item.
ParentName	String	The name of the parent folder or container of the shared item.
Access	String	Indicates the level of availability for the shared item, such as open or restricted.
DownloadCount	Integer	The number of times the shared item has been downloaded.
DownloadUrl	String	The direct URL to download the shared item.
IsPasswordEnabled	String	Indicates whether a password is required to access the shared item.
CanDownload	Boolean	Specifies whether the shared item can be downloaded.
CanPreview	Boolean	Specifies whether the shared item can be previewed.
PreviewCount	Integer	The number of times the shared item has been previewed.
Url	String	The preview URL for the shared item.
Size	Long	The size of the shared item in bytes.
AsUserId	String	The Id of the user you want to impersonate. Only works with Admin, Co-Admin, and Service Accounts.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
SharedLink	String	The shared link used to access the item.
SharedLinkPassword	String	The password for the shared link, if required.

Lists electronic signature requests sent or received through Box Sign, including request status.

Columns

Name	Type	Description
SignRequestAggregate	String	A JSON aggregate representing the details of a Box Sign request, including signer information, document references, and request metadata.
AsUserId	String	The Id of the user you want to impersonate. Only works with Admin, Co-Admin, and Service Accounts.

Provides a record of user activity events in Box, such as logins, file uploads, shares, and collaborations.

Table Specific Information

User events are logs that are saved after a change in a user's account.

Select

Query all the current user's events:

SELECT * FROM UserEvents;

If you're authenticated as an administrator with user impersonation permissions, you can query user events from multiple user accounts:

SELECT * FROM UserEvents WHERE AsUserId IN (SELECT Id FROM Users);

Note: User impersonation has the following limitations:

• The authenticated user cannot be impersonated unless that user is a service account.
• If the authenticated user is a standard user account, they can only query user events associated with their account.
• User events shared with multiple users are only returned for one of the users.

Columns

Name	Type	Description
Id [KEY]	String	The unique identifier of the event.
SourceId	String	The identifier of the source object (such as a file, folder, or user) that triggered the event.
SourceType	String	The type of source object that triggered the event, such as file, folder, or user.
CreatedById	String	The Id of the user who initiated the event.
CreatedByName	String	The name of the user who initiated the event.
CreatedByLogin	String	The login (email) of the user who initiated the event.
CreatedAt	Datetime	The timestamp when the event occurred. This column is only available when streaming events with a StreamType of admin_logs.
RecordedAt	Datetime	The timestamp when the event was logged in the system.
SessionId	String	The identifier for the user session associated with the event.
EventType	String	The type or category of the event, such as file download, item deletion, or login.
ClassificationName	String	The security classification name or label associated with the event, if available.
AdditionalDetails	String	Supplementary metadata about the event, which may include details on how it was performed or external correlation data. Available only for Enterprise Events, and not all events include this object.
AsUserId	String	The Id of the user to impersonate when retrieving events. Only works with Admin, Co-Admin, and Service Accounts.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
StreamType	String	Specifies which type of event stream to use, such as admin_logs for enterprise-level events or user for individual user activity. The allowed values are all, changes, sync, admin_logs, admin_logs_streaming.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Box.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Box, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Box Stored Procedures

Name	Description
AddMetadataTemplatestoFile	Applies a predefined metadata template to a file, creating a structured set of metadata fields for that file.
CopyFile	Creates a copy of an existing file in Box within the same folder or a different destination folder.
CopyFolder	Creates a duplicate of an entire folder, including its subfolders and files, in another location in Box.
CreateSignRequest	Creates a new electronic signature request for documents stored in Box using Box Sign.
DeleteFile	Permanently deletes a specified file from Box.
EmptyTrash	Permanently deletes all items currently in the trash for the authenticated user or enterprise.
LockFile	Locks a file in Box to prevent other users from editing or uploading new versions while the lock is active.
RestoreItem	Restores a previously deleted file or folder from the trash back to its original location.
Search	Performs a global search across Box to find files, folders, and other items matching a search term.
ShareAnItem	Creates or updates a shared link for a file, folder, or bookmark, enabling controlled external access.
UnlockFile	Releases a file lock so that other users can edit or upload a new version.
UpdateFile	Updates the content or metadata of an existing file in Box.

Applies a predefined metadata template to a file, creating a structured set of metadata fields for that file.

Input

Name	Type	Description
FileId	String	Unique identifier of the file to which the metadata template is applied.
TemplateKey	String	The key name of the metadata template that defines the fields to be applied.
Scope	String	The scope of the metadata template, such as enterprise or global.
TemplateValues	String	Optional field that specifies the values for the metadata template. Values must be separated by a semicolon(for example, 'DepartmentName=TestDepartment; DepartmentId=101'.)
AsUserId	String	Identifier of the user to impersonate for API requests, available only for Admin, Co-Admin, and Service Accounts.

Result Set Columns

Name	Type	Description
Success	Bool	Indicates whether the metadata template was successfully added to the file.

Creates a copy of an existing file in Box within the same folder or a different destination folder.

Input

Name	Type	Description
FileID	String	Identifier of the file to be copied.
DestinationFolderId	String	Identifier of the destination folder where the file is copied.
FileVersionID	String	Identifier of a specific file version to copy. If not provided, the most recent version of the file is copied.
NewName	String	Optional new name to assign to the copied file. If omitted, the original name is retained.
AsUserId	String	Identifier of the user to impersonate for API requests, available only for Admin, Co-Admin, and Service Accounts.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the file copy operation completed successfully.
ID	String	Unique identifier assigned to the newly copied file.

Creates a duplicate of an entire folder, including its subfolders and files, in another location in Box.

Input

Name	Type	Description
FolderID	String	Identifier of the folder to be copied.
DestinationFolderId	String	Identifier of the destination folder where the folder is copied.
NewName	String	Optional new name to assign to the copied folder. If omitted, the original name is retained.
AsUserId	String	Identifier of the user to impersonate for API requests, available only for Admin, Co-Admin, and Service Accounts.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the folder copy operation completed successfully.
ID	String	Unique identifier assigned to the newly copied folder.

Creates a new electronic signature request for documents stored in Box using Box Sign.

Execute

To create a Sign Request you must provide a JSON object as the payload for the API request in the SignRequestPayload parameter. For the payload structure refer to the Box API Reference here.

EXEC CreateSignRequest SignRequestPayload = '{"are_reminders_enabled":true,"are_text_signatures_enabled":true,"days_valid":10,"declined_redirect_url":"https://cdata.com/","email_message":"Testing CreateSignRequest stored procedure",...}';

Alternatively, you can specify an absolute path to a file containing the JSON object.

EXEC CreateSignRequest SignRequestPayloadPath = 'C:/Users/User/payload.json';

Input

Name	Type	Description
SignRequestPayload	String	A JSON object that defines the details of the Sign Request to be created, including document information, recipients, and settings.
SignRequestPayloadPath	String	The absolute file path to a local JSON file containing the payload for creating a Sign Request.
AsUserId	String	Identifier of the user to impersonate for API requests, available only for Admin, Co-Admin, and Service Accounts.

Result Set Columns

Name	Type	Description
SignRequestAggregate	String	A JSON object representing the newly created Sign Request, including its unique identifier, status, and configuration details.

Permanently deletes a specified file from Box.

Input

Name	Type	Description
FileID	String	Identifier of the file to be deleted. Only files owned by the authenticated user can be deleted.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the file deletion operation completed successfully.

Permanently deletes all items currently in the trash for the authenticated user or enterprise.

Input

Name	Type	Description
AsUserId	String	Identifier of the user to impersonate for API requests, available only for Admin, Co-Admin, and Service Accounts.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the trash was successfully emptied.

Locks a file in Box to prevent other users from editing or uploading new versions while the lock is active.

Input

Name	Type	Description
FileId	String	The unique identifier of the file to be locked.
ExpiresAt	Datetime	The timestamp when the lock expires. If not provided, the lock remains until it is manually removed.
PreventDownload	Bool	Indicates whether downloading the locked file should be prevented while the lock is active. The default value is false.
AsUserId	String	The Id of the user to impersonate when performing the operation. Only works with Admin, Co-Admin, and Service Accounts.

Result Set Columns

Name	Type	Description
Success	Bool	Indicates whether the file was successfully locked.

Restores a previously deleted file or folder from the trash back to its original location.

Input

Name	Type	Description
ItemId	String	The Id of the file or folder to be restored from the trash.
ItemType	String	The type of item to restore. Supported values are Files and Folders.
NewName	String	An optional new name to assign to the restored item if you do not want to use the original name.
NewParentId	String	An optional parent folder Id to place the restored item into. Used if the original parent folder no longer exists.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the file or folder was successfully restored.
ID	String	The unique identifier of the restored item.
ParentId	String	The identifier of the parent folder containing the restored item.

Performs a global search across Box to find files, folders, and other items matching a search term.

Input

Name	Type	Description
SearchTerm	String	The keyword or phrase to use when performing a global search across files, folders, and other Box items.

Result Set Columns

Name	Type	Description
Results	String	The raw JSON response containing the results of the global search, including matching items and their details.

Creates or updates a shared link for a file, folder, or bookmark, enabling controlled external access.

Input

Name	Type	Description
ItemId	String	The Id of the item to share.
ItemType	String	The type of item being shared. The allowed values are file, folder, bookmark. The default value is file.
Access	String	Specifies the access level of the shared link. The allowed values are open, company, collaborators. The default value is open.
Unshared_At	String	The expiration date when the shared link is automatically disabled.
Password	String	A password required to access the shared link, if enabled.
Can_Preview	Boolean	Indicates whether the item can be previewed through the shared link. Can only be set with open or company access. The default value is true.
Can_Download	Boolean	Indicates whether the item can be downloaded through the shared link. Applicable only to files and folders, not bookmarks. Can only be set with open or company access. The default value is true.
AsUserId	String	The Id of the user you want to impersonate. Only works with Admin, Co-Admin, and Service Accounts.

Result Set Columns

Name	Type	Description
Url	String	The URL of the newly created shared link.
Download_Url	String	The direct download URL for the shared item.
Download_Count	String	The number of times the item has been downloaded from the shared link.
Is_Password_Enabled	String	Indicates whether the shared link is protected by a password.
Unshared_At	String	The expiration date when the shared link was or will be disabled.
Preview_Count	String	The number of times the item has been previewed through the shared link.
Effective_Access	String	The effective access level applied to the shared link, as enforced by administrators.
Success	String	Whether or not the item was successfully shared.

Releases a file lock so that other users can edit or upload a new version.

Input

Name	Type	Description
FileId	String	The Id of the file you want to unlock.
AsUserId	String	The Id of the user you want to impersonate. Only works with Admin, Co-Admin, and Service Accounts.

Result Set Columns

Name	Type	Description
Success	Bool	Indicates whether the file was successfully unlocked.

Updates the content or metadata of an existing file in Box.

Input

Name	Type	Description
FileID	String	The unique identifier of the file to be copied.
NewName	String	An optional new name for the copied file; if not provided, the original name is used.
Description	String	An optional description to assign to the copied file.
Parent	String	The identifier of the parent folder where the copied file should be placed. This can be used to move the file into a different folder.
CanDownload	String	Specifies who can download the copied file. Accepted values are 'open' (available to everyone) or 'company' (restricted to members of the user's enterprise).
Tags	String	A comma-separated list of tags to associate with the copied file. Each item supports up to 100 tags, with a maximum of 10,000 unique tags allowed per enterprise.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the file was successfully copied.
ID	String	The identifier of the newly copied file.

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Box:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Files table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Files' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType	String	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the UploadFile stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'UploadFile' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'UploadFile' AND IncludeResultColumns='True'

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native Box procedure.

Pseudo-Columns

Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

Describes the primary and foreign keys.

The following query retrieves the primary key for the Files table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Files' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
AuthScheme	Specifies the type of authentication to use when connecting to Box.
ImpersonateUserMode	Specify the type of the user impersonation. It should be whether the User mode or the Admin mode.

JWT OAuth

---

Property	Description
OAuthJWTSubjectType	The SubType for the JWT authentication.
OAuthJWTPublicKeyId	The Id of the public key for JWT.

OAuth

---

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
SubjectId	The user subject for which the application is requesting delegated access.
SubjectType	The Subject Type for the Client Credentials authentication.

SSL

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Logging

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

---

Property	Description
AsUserId	Specifies the Box user ID to impersonate when making API calls. Only supported for Admin, Co-Admin, or Service Accounts.
DirectoryRetrievalDepth	Specifies the maximum folder depth the provider retrieves when querying the Folders and Files tables.
ExposeCollectionViews	Determines whether to expose every collection in your Box account as separate views.
IncludeCustomFields	Specifies whether the provider includes Box metadata templates as custom columns in the Files table.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFound	Specifies whether or not throws an exception if there is no rows updated.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	Specifies the type of authentication to use when connecting to Box.
ImpersonateUserMode	Specify the type of the user impersonation. It should be whether the User mode or the Admin mode.

Specifies the type of authentication to use when connecting to Box.

Possible Values

OAuth, OAuthJWT, OAuthClient

Data Type

string

Default Value

"OAuth"

Remarks

• OAuth: Uses OAuth authentication using a standard user account.
• OAuthJWT: Uses OAuth authentication using an OAuth service account.
• OAuthClient: Uses Client Credentials authentication.

Specify the type of the user impersonation. It should be whether the User mode or the Admin mode.

Possible Values

User, Admin

Data Type

string

Default Value

"User"

Remarks

Specify the type of the user impersonation. It should be whether the User mode or the Admin mode. The Admin mode is available only for Enterprise with Governance accounts and will be upon request. It will not work for any other accounts.

This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthJWTSubjectType	The SubType for the JWT authentication.
OAuthJWTPublicKeyId	The Id of the public key for JWT.

The SubType for the JWT authentication.

Possible Values

enterprise, user

Data Type

string

Default Value

"enterprise"

Remarks

The SubType for the JWT authentication. Set this to "enterprise" or "user" depending on the type of token being requested.

The Id of the public key for JWT.

Data Type

string

Default Value

""

Remarks

The Id of the public key for JWT. Set this to the value of your Public Key Id in your app settings.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
SubjectId	The user subject for which the application is requesting delegated access.
SubjectType	The Subject Type for the Client Credentials authentication.

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

• When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
• If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

• This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
• Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

The user subject for which the application is requesting delegated access.

Data Type

string

Default Value

""

Remarks

Id of the user or enterprise, based on the configuration set in SubjectType.

The Subject Type for the Client Credentials authentication.

Possible Values

enterprise, user

Data Type

string

Default Value

"enterprise"

Remarks

The Subject Type for the Client Credentials authentication. Set this to "enterprise" or "user" depending on the type of token being requested.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space- or colon-separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space- or colon-separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
AsUserId	Specifies the Box user ID to impersonate when making API calls. Only supported for Admin, Co-Admin, or Service Accounts.
DirectoryRetrievalDepth	Specifies the maximum folder depth the provider retrieves when querying the Folders and Files tables.
ExposeCollectionViews	Determines whether to expose every collection in your Box account as separate views.
IncludeCustomFields	Specifies whether the provider includes Box metadata templates as custom columns in the Files table.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFound	Specifies whether or not throws an exception if there is no rows updated.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Specifies the Box user ID to impersonate when making API calls. Only supported for Admin, Co-Admin, or Service Accounts.

Data Type

string

Default Value

""

Remarks

If you set this property, the Cloud uses the Box as-user header to act on behalf of the specified user.

This property only works when authenticated with an Admin, Co-Admin, or Service Account.

If a user ID is also provided in a pseudo-column or a stored procedure parameter, those values take precedence over this property.

Specifies the maximum folder depth the provider retrieves when querying the Folders and Files tables.

Data Type

string

Default Value

"5"

Remarks

This property controls how many levels of nested folders the Cloud scans when querying the Folders and Files tables.

If this property is not set, the Cloud uses a default retrieval depth of 5.

Use a lower value to reduce query time in environments with large directory structures, or increase it if you need to access deeply nested files and folders.

Determines whether to expose every collection in your Box account as separate views.

Data Type

bool

Default Value

false

Remarks

This property determines whether the Cloud exposes Box Collections as individual queryable views.

If this property is set to true, each Box Collection in your account appears as a separate view that you can query to access its files and folders.

If this property is set to false, Box Collections are not included in the schema.

Enable this property if you want to access curated sets of items stored in Collections directly from your query environment.

Specifies whether the provider includes Box metadata templates as custom columns in the Files table.

Data Type

bool

Default Value

false

Remarks

This property determines whether the Cloud includes Box metadata templates as custom columns in the Files table.

If this property is set to true, metadata templates defined in your Box environment appear as additional columns when querying the Files table.

If this property is set to false, metadata templates are not included.

Enable this property if you want to retrieve custom metadata fields alongside standard file information.

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

Specifies whether or not throws an exception if there is no rows updated.

Data Type

bool

Default Value

false

Remarks

Specifies whether or not throws an exception if there is no rows updated.

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.