Box への接続を追加

Box への接続を追加するには：

1. アプリケーションコンソールで、接続ページに移動します。
2. 接続の追加パネルで、追加したい接続のアイコンを選択します。
3. Box アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからBox コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

Box への接続

Sync App は、Box テーブルおよびフォルダへのアクセスを実現します。なお、Sync App はBox に格納されているファイルの内容を更新したり、ファイルの内容をテーブルやカラムとしてモデル化したりはできません。

Box への認証

Sync App は、OAuth 認証標準を使用して、ユーザーアカウントまたはサービスアカウントからBox に接続します。

Box は埋め込みOAuth クレデンシャルを提供しており、デスクトップアプリケーション からの接続を簡単にします。Web アプリケーションから接続するには、カスタムOAuth アプリケーションの作成 で説明するようにカスタムOAuth アプリケーションを作成する必要があります。

以下のサブセクションでは、利用可能なOAuth フローでのBox への認証について詳しく説明します。 カスタムOAuth アプリケーションの作成についての情報と、すでに埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成 を参照してください。

Box で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

ユーザーアカウント（OAuth）

AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。

サービスアカウント（OAuthJWT）

サービスアカウントには、ブラウザによるユーザー認証が不要なサイレント認証があります。また、サービスアカウントを使用して、エンタープライズ全体のアクセススコープをSync App に委任することもできます。

サービスアカウントを使用するには、カスタムOAuth アプリケーションの作成 で説明するように、カスタムOAuth アプリケーションの作成と認可が必要です。 これでサービスアカウントにアクセス権があるBox データに接続できます。

次の接続プロパティを設定して、接続してください。

• AuthScheme：OAuthJWT。
• OAuthClientId：カスタムOAuth アプリケーションの設定で指定したクライアントId。
• OAuthClientSecret：カスタムOAuth アプリケーションの設定で指定したクライアントシークレット。
• OAuthJWTCertType：PEMKEY_FILE。
• OAuthJWTCert：生成した.pem ファイルのパス。
• OAuthJWTCertPassword：.pem ファイルのパスワード。
• OAuthJWTCertSubject：証明書のサブジェクト。証明書ストアの1番目の証明書を選択するには、*（アスタリスク）を設定します。
• OAuthJWTSubjectType：Application Access Values で指定した値と同じで、"enterprise" または"user" のいずれか。 この接続プロパティのデフォルト値は"enterprise" です。
• OAuthJWTSubject：サブジェクトタイプがenterprise に設定されている場合は、これをエンタープライズID に設定します。 サブジェクトタイプがuser に設定されている場合は、アプリケーションのユーザーID に設定します。
• OAuthJWTPublicKeyId：アプリケーション設定の公開キーID。

接続すると、Sync App はサービスアカウントでのOAuth フローを完了します。

BOXJSON OAuthJWTCertType

サービスアカウントおよびBOXJSON OauthJWTCertType を使用して認証するには、以下のプロパティを設定します。

• AuthScheme：OAuthJWT。
• OAuthJWTCertType：BOXJSON。 OAuthJWTCert：Box が提供するJSON ファイルへのパス。

システム内のファイルを使用するのが難しい場合は、JSON ファイルの内容を接続文字列に直接コピーすることができます。 次のプロパティを設定します。

• AuthScheme：OAuthJWT。
• OAuthJWTCertType：BOXJSONBLOB。
• OAuthJWTCert：Box が提供するJSON ファイルの内容。

このセクションでは、Box Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Box にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくは、クエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングに必要なのは2つの接続プロパティだけですが、より詳細なロギングをサポートする多くの機能があり、LogModules 接続プロパティを使用してロギングする情報のサブセットを指定することができます。

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Sync App はBox データを使いやすいSQL データベースとしてモデル化します。データモデルには3つのパートがあります。テーブル、ビュー、およびストアドプロシージャです。

テーブル

テーブル セクションには標準SQL テーブルの詳細が、ビュー セクションには読み取り専用SQL テーブルの一覧が記載されています。これらには、Box アカウントでのアクセスを想定したサンプルが含まれています。

一般的なテーブルには以下のものが含まれます。

テーブル	説明
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.

ストアドプロシージャ

ストアドプロシージャ は、SQL クエリを介して呼び出されるアクションです。ファイルのダウンロード、アップロード、コピーなど、標準的な作成、読み取り、更新、削除（CRUD）操作を超えるタスクを実行します。

SQLステートメントで指定された場合、Sync App は可能な限りLIMIT 句とOFFSET 句をサーバーにプッシュしようとします。ただし、LIMIT の最大サポート値は1000です。

一部のテーブルは、LIMIT およびOFFSET 句をサポートしていません。これらのテーブルおよびグローバル検索エンドポイントがヒットした場合、これらの句はクライアントサイドで評価されます。

ExposeCollectionViews を使用して、Box コレクションを個別のビューとして公開し、そのファイルやフォルダのメタデータ情報をクエリできます。生成されるビューの名前には、Collection_ という接頭辞が付きます。

また、AsUserId を使用して特定のユーザーのコレクションを公開したり、IncludeCustomFields を使用してカスタムメタデータフィールドを生成されたビューのカラムとして公開することもできます。

Sync App はBox のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

Box Connector for CData Sync テーブル

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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. 使用できる値は次のとおりです。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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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. 使用できる値は次のとおりです。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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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.

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

Box Connector for CData Sync ビュー

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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. 使用できる値は次のとおりです。all, changes, sync, admin_logs, admin_logs_streaming

ストアドプロシージャはファンクションライクなインターフェースで、Box の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにBox から関連するレスポンスデータを返します。

Box Connector for CData Sync ストアドプロシージャ

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.

Generates a schema file that defines the structure of a specified Box table or view for integration or analysis.

CreateSchema

データモデル内の既存のテーブルまたはビューからローカルスキーマファイル（.rsd）を作成します。

スキーマファイルは、このプロシージャが実行されると、Location 接続プロパティで設定されたディレクトリに作成されます。ファイルを編集してカラムを含めたり除外したり、カラム名を変更したり、カラムのデータ型を変更したりできます。

Sync App はLocation を確認し、.rsd ファイルの名前がデータモデルのテーブルまたはビューに一致するかどうかを判断します。重複がある場合、スキーマファイルはデータモデル内のこのテーブルのデフォルトインスタンスよりも優先されます。既存のテーブルまたはビューに一致しないスキーマファイルがLocation に存在する場合、新しいテーブルまたはビューのエントリがSync App のデータモデルに追加されます。

Input

Name	Type	Description
TableName	String	The name of the Box table or view for which the schema definition will be generated.
FileName	String	The full file path and name where the generated schema will be saved (for example, 'C:\\Users\\User\\Desktop\\Box\\CustomTable.rsd').

Result Set Columns

Name	Type	Description
Result	String	Indicates whether the schema generation completed successfully or failed.
FileData	String	The generated schema file data encoded in Base64, returned when FileName and FileStream are not specified.

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.

Downloads the contents of a file from Box to a local system or application.

Input

Name	Type	Description
FileID	String	Identifier of the file to be downloaded.
FileVersionID	String	Identifier of a specific file version to download. If not provided, the most recent version is downloaded.
DownloadTo	String	The file path where the downloaded file should be saved locally.
AsUserId	String	Identifier of the user to impersonate for API requests, available only for Admin, Co-Admin, and Service Accounts.
UseSimpleName	Boolean	When set to true, removes unsupported special characters from the file name to ensure compatibility with operating systems that restrict certain characters. Characters removed include forward slash, backslash, colon, asterisk, question mark, double-quote, less than, greater than, and vertical bar. デフォルト値はfalseです。
Name	String	The name to use when saving the file after download. If left blank, the original file name is used.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the file download operation completed successfully.
FileData	String	The downloaded file data encoded in Base64, returned when neither DownloadTo nor FileStream are specified.

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.

Retrieves an OAuth access token from Box to authenticate API requests.

Input

Name	Type	Description
AuthMode	String	Specifies the authentication flow to use. Choose 'App' to retrieve tokens via a desktop app flow, or 'Web' to retrieve tokens via a web application flow. 使用できる値は次のとおりです。APP, WEB デフォルト値はWEBです。
CallbackUrl	String	The redirect URL where the user is sent after authorizing your application. This must exactly match the Redirect URL configured in your Box app settings. Required only when using AuthMode=Web.
Scope	String	A space- or comma-separated list of permissions (scopes) that define the level of access requested. Refer to the Box API documentation for available scopes.
Verifier	String	The authorization verifier returned by Box after the user grants access to your app. It is included as a parameter in the redirect CallbackUrl and is required to complete the token exchange.
State	String	An optional string used to maintain state between the request and callback. The same value sent is returned by Box, allowing use cases such as redirecting the user to a specific resource, mitigating CSRF, or including a nonce for security.
GrantType	String	Determines how to retrieve the access token. 使用できる値は次のとおりです。CODE, CLIENT デフォルト値はCODEです。

Result Set Columns

Name	Type	Description
OAuthAccessToken	String	The short-lived access token returned from Box, used to authenticate API requests.
OAuthRefreshToken	String	The refresh token that can be used to obtain new access tokens when the current one expires. In Box, this value may be the same as the access token.
ExpiresIn	String	The lifetime of the access token in seconds. A value of -1 indicates the token does not expire.

Generates the authorization URL that a user must visit to grant application access during the OAuth authentication process.

Input

Name	Type	Description
CallbackUrl	String	The redirect URL where the user is sent after authorizing your application. This must exactly match the Redirect URL defined in your Box app settings.
Scope	String	A comma-separated list of scopes (permissions) your application is requesting from the user. Refer to the Box API for supported scope values.
Grant_Type	String	Specifies the authorization grant type for the OAuth flow. 使用できる値は次のとおりです。code, token デフォルト値はcodeです。
State	String	An optional value that is passed through the OAuth flow and returned unchanged by Box. Often used to preserve application state, identify a session, mitigate CSRF attacks, or redirect the user to a specific resource after authorization.

Result Set Columns

Name	Type	Description
URL	String	The generated authorization URL. Direct the user to this URL in a browser so they can grant access to your app and obtain the authorization verifier token.

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. デフォルト値は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.

Refreshes an existing OAuth access token to maintain authentication without requiring user reauthorization.

Input

Name	Type	Description
OAuthRefreshToken	String	The refresh token that was issued with the original access token. Used to request a new access token when the old one expires.

Result Set Columns

Name	Type	Description
OAuthAccessToken	String	The new access token returned from Box, used for authenticated API requests.
OAuthRefreshToken	String	The updated refresh token returned by Box, to be stored for the next token refresh request.
ExpiresIn	String	The number of seconds until the newly issued access token expires.

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. 使用できる値は次のとおりです。file, folder, bookmark デフォルト値はfileです。
Access	String	Specifies the access level of the shared link. 使用できる値は次のとおりです。open, company, collaborators デフォルト値は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. デフォルト値は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. デフォルト値は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.

Uploads a new file into a specified Box folder.

Input

Name	Type	Description
FilePath	String	The full local path of the file, including its name, to upload. This takes precedence over the Content input.
ParentId	String	The identifier of the parent folder where the file will be uploaded. If not provided, the file is uploaded to the root folder of the Box account. デフォルト値は0です。
AsUserId	String	The Id of the user to impersonate during the upload. Only works with Admin, Co-Admin, and Service Accounts.
FileName	String	The name of the file to upload, including its extension. Required if Content is specified. If FilePath is also provided, this value overrides the file's original name.
CreatedAt	Datetime	An optional timestamp indicating when the file was originally created. Defaults to the upload time if not set. Format example: '2020-01-01T12:00:00-05:00'.
ModifiedAt	Datetime	An optional timestamp indicating when the file was last modified. Defaults to the upload time if not set. Format example: '2020-01-01T12:00:00-05:00'.
Hash	String	An optional SHA1 hash of the file to validate that the file was not corrupted during upload.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the file was uploaded successfully.
ID	String	The unique identifier of the uploaded file.
VersionID	String	The identifier for the specific version of the uploaded file.
Hash	String	The SHA1 hash of the uploaded file, used for integrity verification.
Etag	String	The entity tag of the uploaded file, used for versioning and concurrency control.

Uploads a new version of an existing file, maintaining version history in Box.

Input

Name	Type	Description
FilePath	String	The full local path of the file, including its name, for the new version upload.
FileId	String	The unique identifier of the file whose version is being updated.
NewName	String	An optional new name for the file. If provided, the file is renamed during the upload of the new version. The name must include the file extension (for example, SampleFile.txt).
AsUserId	String	The Id of the user to impersonate when uploading the new version. Only works with Admin, Co-Admin, and Service Accounts.
ModifiedAt	Datetime	An optional timestamp indicating when the file was last modified. If not set, the upload time is used. Example format: '2020-01-01T12:00:00-05:00'.
Hash	String	An optional SHA1 hash of the file used to verify the file's integrity during upload.
IfMatch	String	An optional concurrency control header. Provide the file's most recent etag to ensure it has not changed before updating. If the etag does not match, the request fails with a 412 Precondition Failed.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the new file version was uploaded successfully.
ID	String	The unique identifier of the updated file.
VersionID	String	The identifier for the specific version of the file that was uploaded.
Hash	String	The SHA1 hash of the uploaded file version, used for integrity verification.
Etag	String	The entity tag of the updated file, used for versioning and concurrency control.

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

---

プロパティ	説明
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

---

プロパティ	説明
OAuthJWTCert	クライアント証明書のJWT 証明書ストアの名前を指定します。
OAuthJWTCertType	JWT 証明書を格納しているキーストアの種類を指定します。
OAuthJWTCertPassword	パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubject	ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
OAuthJWTIssuer	Java Web Token の発行者。
OAuthJWTSubject	アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。
OAuthJWTSubjectType	JWT 認証のサブタイプ。
OAuthJWTPublicKeyId	JWT の公開キーのID。

OAuth

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecret	カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）
SubjectId	The user subject for which the application is requesting delegated access.
SubjectType	The Subject Type for the Client Credentials authentication.

SSL

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Firewall

---

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy

---

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。

Logging

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

Schema

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Miscellaneous

---

プロパティ	説明
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	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
Other	特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

---

プロパティ	説明
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.

解説

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

解説

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.

このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。

---

プロパティ	説明
OAuthJWTCert	クライアント証明書のJWT 証明書ストアの名前を指定します。
OAuthJWTCertType	JWT 証明書を格納しているキーストアの種類を指定します。
OAuthJWTCertPassword	パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubject	ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
OAuthJWTIssuer	Java Web Token の発行者。
OAuthJWTSubject	アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。
OAuthJWTSubjectType	JWT 認証のサブタイプ。
OAuthJWTPublicKeyId	JWT の公開キーのID。

クライアント証明書のJWT 証明書ストアの名前を指定します。

解説

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword を使用してパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値が設定され、かつOAuthJWTCertSubject が設定されている場合、CData Sync App は証明書の検索を開始します。 詳しくは、OAuthJWTCertSubject を参照してください。

証明書ストアの指定はプラットフォームに依存します。

注記

• Windows の共通のユーザーとシステム証明書ストアは以下のとおりです。
  • MY：個人証明書と関連付けられた秘密キーを 格納している証明書ストア。
  • CA：証明機関の証明書。
  • ROOT：ルート証明書。
  • SPC：ソフトウェア発行元証明書。
• Javaでは、証明書ストアは通常、証明書および 任意の秘密キーを含むファイルです。
• 証明書ストアの種類がPFXFile の場合は、 このプロパティにファイル名を設定します。
• PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。

JWT 証明書を格納しているキーストアの種類を指定します。

解説

値	説明	注記
USER	現在のユーザーが所有する証明書ストア。	Windows のみ使用可能です。
MACHINE	マシンストア。	Java やその他の非Windows 環境では使用できません。
PFXFILE	証明書を含むPFX（PKCS12）ファイル。
PFXBLOB	PFX（PKCS12）形式の証明書ストアをbase-64 でエンコードした文字列。
JKSFILE	証明書を含むJava キーストア（JKS）ファイル。	Java 専用。
JKSBLOB	Java キーストア（JKS）形式の証明書ストアをbase-64 でエンコードした文字列。	Java 専用。
PEMKEY_FILE	秘密鍵とオプションの証明書を含むPEM でエンコードされたファイル。
PEMKEY_BLOB	秘密鍵とオプションの証明書をbase-64 でエンコードした文字列。
PUBLIC_KEY_FILE	PEM またはDER でエンコードされた公開鍵証明書を含むファイル。
PUBLIC_KEY_BLOB	PEM またはDER でエンコードされた公開鍵証明書をbase-64 でエンコードした文字列。
SSHPUBLIC_KEY_FILE	SSH 形式の公開鍵を含むファイル。
SSHPUBLIC_KEY_BLOB	SSH 形式の公開鍵ををbase-64 でエンコードした文字列。
P7BFILE	証明書を含むPKCS7 ファイル。
PPKFILE	PuTTY 秘密キー（PPK）を含むファイル。
XMLFILE	XML 形式の証明書を含むファイル。
XMLBLOB	XML 形式の証明書を含む文字列。
BCFKSFILE	Bouncy Castle キーストアを含むファイル。
BCFKSBLOB	Bouncy Castle キーストアを含む文字列（base-64エンコード）。
BOXJSON	サービスアカウント情報を含むJSON ファイル。	Box に接続する場合にのみ有効。
BOXJSONBLOB	この証明書ストアは、サービスアカウントのJSON を含む文字列です。	Box に接続する場合にのみ有効。

パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。

解説

このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。

ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。

解説

このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。

• サブジェクトに完全に一致する証明書が見つかれば、該当する証明書が選択されます。
• 完全に一致するものがない場合、ストアは、サブジェクトがプロパティ値を含む証明書を検索します。
• 一致する証明書がない場合、証明書は選択されません。

値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例：CN=www.server.com, OU=test, C=US, [email protected]。

一般的なフィールドには以下のものが含まれます。

フィールド	説明
CN	共通名。一般的には、www.server.com のようなホスト名です。
O	法人名
OU	法人の部署名
L	法人の住所（市町村名）
S	法人の住所（都道府県）
C	国名
E	E メールアドレス

フィールド値にカンマが含まれる場合は、引用符で囲んでください。例："O=ACME, Inc."。

Java Web Token の発行者。

解説

Java Web Token の発行者。 通常は、OAuth アプリケーションのクライアントId またはE メールアドレスとなります。

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

解説

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。通常は、ユーザーのアカウント名またはE メールアドレスとなります。

JWT 認証のサブタイプ。

解説

JWT 認証のサブタイプ。要求されているトークンの種類に応じて［enterprise］または［user］に設定します。

JWT の公開キーのID。

解説

JWT の公開キーのID。アプリケーション設定の公開キーID の値に設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecret	カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）
SubjectId	The user subject for which the application is requesting delegated access.
SubjectType	The Subject Type for the Client Credentials authentication.

カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

解説

このプロパティは2つのケースで必要となります：

• カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
• ドライバーが埋め込みOAuth 資格情報を提供しない場合。

（ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにSync App によって設定されており、手動で入力する必要がないことがあります。）

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）

解説

このプロパティ（アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます）は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes：

• この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
• クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

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

解説

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

The Subject Type for the Client Credentials authentication.

解説

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

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

解説

TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint（hex 値はスペースまたはコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint（hex 値はスペースまたはコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

Note：'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

---

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。

プロトコル	デフォルトポート	説明
TUNNEL	80	Sync App がBox への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4	1080	Sync App がBox への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	Sync App がBox にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

---

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を構成する場合は、ProxyAutoDetect をFalse に設定します。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。

ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。

ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

サポートされる認証の種類：

• BASIC：Sync App はHTTP Basic 認証を行います。
• DIGEST：Sync App はHTTP ダイジェスト認証を行います。
• NTLM：Sync App はNTLM トークンを取得します。
• NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
• NONE：ProxyServer が認証を必要としないことを示します。

NONE 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値	ProxyUser に設定する値
BASIC	プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST	プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NTLM	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NONE	ProxyPassword 接続プロパティは設定しないでください。

Note：Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。 ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値	ProxyPassword に設定する値
BASIC	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE	ProxyPassword 接続プロパティは設定しないでください。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

Note：Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。 ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。

AUTO	デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Note：Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。 この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

Sync App は、実行する各操作の詳細を Logfile 接続プロパティで指定されたログファイルに書き込みます。

ログに記録される各操作は、モジュールと呼ばれるカテゴリに分類されます。各モジュールには対応する短いコードがあり、個々の Sync App の操作がどのモジュールに属するかを示すラベルとして使用されます。

この接続プロパティにモジュールコードをセミコロン区切りのリストで設定すると、指定したモジュールに属する操作のみがログファイルに書き込まれます。この設定は今後のログ記録にのみ適用され、既存のログファイルの内容には影響しません。例: INFO;EXEC;SSL;META;

デフォルトでは、すべてのモジュールの操作がログに含まれます。

モジュールを明示的に除外するには、先頭に「-」を付けます。例: -HTTP

サブモジュールにフィルターを適用するには、<モジュール名>.<サブモジュール名> の構文で指定します。たとえば、次の値を設定すると、Sync App は HTTP モジュールに属するアクションのみをログに記録し、さらに HTTP モジュールの Res サブモジュールに属するアクションを除外します: HTTP;-HTTP.Res

Verbosity 接続プロパティによるログファイルのフィルタリングは、この接続プロパティによるフィルタリングよりも優先されます。そのため、Verbosity 接続プロパティで指定したレベルよりも高い詳細レベルの操作は、この接続プロパティで指定したモジュールに属していても、ログファイルには出力されません。

使用可能なモジュールとサブモジュールは次のとおりです。

モジュール名	モジュールの説明	サブモジュール
INFO	一般情報。接続文字列、製品バージョン（ビルド番号）、および初期接続メッセージが含まれます。	Connec — 接続の作成または破棄に関連する情報。 Messag — 接続、接続文字列、製品バージョンに関するメッセージの汎用ラベル。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。
EXEC	クエリ実行。ユーザーが記述した SQL クエリ、解析済み SQL クエリ、正規化済み SQL クエリの実行メッセージが含まれます。クエリおよびクエリページの成功/失敗メッセージもここに表示されます。	Messag — クエリ実行に関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 Normlz — クエリの正規化ステップ。クエリの正規化とは、ユーザーが送信したクエリを、最適なパフォーマンスで同じ結果を得られるように書き換える処理です。 Origin — ユーザーの元のクエリ（ユーザーが実行した正確で未変更の非正規化クエリ）を記録するメッセージに適用されるラベル。 Page — クエリのページングに関連するメッセージ。 Parsed — クエリの解析ステップ。解析とは、ユーザーが送信したクエリを、処理しやすい標準化された形式に変換するプロセスです。
HTTP	HTTP プロトコルメッセージ。HTTP リクエスト/レスポンス（POST メッセージを含む）、および Kerberos 関連のメッセージが含まれます。	KERB — Kerberos に関連する HTTP リクエスト。 Messag — HTTP プロトコルに関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 Unpack — サービス API から返された圧縮データを製品が解凍する際のメッセージに適用されるラベル。 Res — HTTP レスポンスを含むメッセージ。 Req — HTTP リクエストを含むメッセージ。
WSDL	WSDL/XSD ファイルの生成に関するメッセージ。	—
SSL	SSL 証明書メッセージ。	Certif — SSL 証明書に関するメッセージ。
AUTH	認証関連の失敗/成功メッセージ。	Messag — 認証に関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 OAuth — OAuth 認証に関連するメッセージ。 Krbros — Kerberos 関連の認証メッセージ。
SQL	SQL トランザクション、SQL 一括転送メッセージ、および SQL 結果セットメッセージが含まれます。	Bulk — 一括クエリ実行に関するメッセージ。 Cache — パフォーマンス向上のため、製品のキャッシュへの行データの読み書きに関連するメッセージ。 Messag — SQL トランザクションに関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 ResSet — クエリの結果セット。 Transc — 実行されたジョブ数やバックアップテーブルの処理に関する情報を含む、トランザクション処理に関連するメッセージ。
META	メタデータキャッシュとスキーマメッセージ。	Cache — パフォーマンス向上のため、製品のキャッシュ内のカラムおよびテーブル定義の読み取りと変更に関連するメッセージ。 Schema — サービススキーマからのメタデータの取得またはサービススキーマの変更に関連するメッセージ。 MemSto — インメモリメタデータキャッシュへの書き込みまたは読み取りに関連するメッセージ。 Storag — メモリ内ではなく、ディスクまたは外部データストアへのメタデータの保存に関連するメッセージ。
FUNC	SQL 関数の実行に関連する情報。	Errmsg — SQL 関数の実行に関連するエラーメッセージ。
TCP	TCP トランスポートレイヤーメッセージでの送受信生バイト。	Send — TCP プロトコル経由で送信された生データ。 Receiv — TCP プロトコル経由で受信した生データ。
FTP	File Transfer Protocol に関するメッセージ。	Info — FTP プロトコルでの通信に関連するステータスメッセージ。 Client — FTP 通信中に FTP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — FTP 通信中に FTP サーバーが実行したアクションに関連するメッセージ。
SFTP	Secure File Transfer Protocol に関するメッセージ。	Info — SFTP プロトコルでの通信に関連するステータスメッセージ。 To_Server — SFTP 通信中に SFTP クライアント（製品）が実行したアクションに関連するメッセージ。 From_Server — SFTP 通信中に SFTP サーバーが実行したアクションに関連するメッセージ。
POP	Post Office Protocol 経由で転送されるデータに関するメッセージ。	Client — POP 通信中に POP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — POP 通信中に POP サーバーが実行したアクションに関連するメッセージ。 Status — POP プロトコルでの通信に関連するステータスメッセージ。
SMTP	Simple Mail Transfer Protocol 経由で転送されるデータに関するメッセージ。	Client — SMTP 通信中に SMTP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — SMTP 通信中に SMTP サーバーが実行したアクションに関連するメッセージ。 Status — SMTP プロトコルでの通信に関連するステータスメッセージ。
CORE	他のモジュールでカバーされていない、さまざまな製品内部操作に関連するメッセージ。	—
DEMN	SQL リモーティングに関連するメッセージ。	—
CLJB	一括データアップロード（クラウドジョブ）に関するメッセージ。	Commit — 一括データアップロードの送信。
SRCE	他のモジュールに属さない、製品が生成するその他のメッセージ。	—
TRANCE	低レベルの製品操作に関する高度なメッセージ。	—

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\Box Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます：

プラットフォーム	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。

解説

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

解説

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

---

プロパティ	説明
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	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
Other	特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

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

解説

If you set this property, the Sync App 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.

解説

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

If this property is not set, the Sync App 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.

解説

This property determines whether the Sync App 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.

解説

This property determines whether the Sync App 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.

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 （クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。）

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。

解説

このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

Note：特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

統合およびフォーマット

プロパティ	説明
DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT=True	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換します。デフォルト値はFalse（ローカルタイムを使用）です。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

解説

このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください：

*=*

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note： このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

UserDefinedViews を使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。

次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Files WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 次に例を示します。

UserDefinedViews=C:\Path\To\UserDefinedViews.json

UserDefinedViews でビューを指定すると、Sync App はそのビューだけを参照します。

詳しくは、ユーザー定義ビュー を参照してください。

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.