Query, insert, update and delete the available bookmarks in Box.

Table Specific Information

Select

If you search for bookmarks without specifying any condition in the WHERE Clause, by default only the bookmarks that are at most 5 levels deep from the root folder will be returned. You can change the default depth value in the connection string; e.g. DirectoryRetrievalDepth=10.

SELECT * FROM Bookmarks

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 column SearchTerms.

SELECT * FROM Bookmarks WHERE SearchTerms LIKE '%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

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

Bookmarks can be deleted by providing an Id and issuing a DELETE statement. This bookmark is then moved to TrashedItems.

DELETE FROM Bookmarks WHERE Id = 8397822180

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the bookmark.
Url	String	False	The URL of the bookmark.
Name	String	False	The name of the bookmark.
Description	String	False	The description of the bookmark.
ParentId	String	False	The Id of the folder that contains the bookmark.
CreatedAt	Datetime	True	The date the content of the bookmark was created at.
CreatedById	String	True	The Id of the user that created the bookmark.
CreatedByName	String	True	The Name of the user that created the bookmark.
CreatedByLogin	String	True	The Login of the user that created the bookmark.
ModifiedAt	Datetime	True	The date the content of the bookmark was modified at.
ModifiedById	String	True	The Id of the user that last modified the bookmark.
ModifiedByName	String	True	The Name of the user that last modified the bookmark.
ModifiedByLogin	String	True	The Login of the user that last modified the bookmark.
OwnedById	String	True	The Id of the user that owns the bookmark.
OwnedByName	String	True	The Name of the user that owns the bookmark.
OwnedByLogin	String	True	The Login of the user that owns the bookmark.
Etag	String	True	The Etag of the bookmark
SequenceId	String	True	The sequence Id of the bookmark.
SharedLink	String	True	The shared url of the bookmark.
ItemStatus	String	True	The status of the bookmark.
Path	String	True	The full path of the bookmark.
AsUserId	String	False	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.

Pseudo-Columns

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

Name	Type	Description
SearchTerms	String	Query to search the bookmarks database.
Scope	String	The scope of the search. The allowed values are user_content, enterprise_content.
OwnerUserIDs	String	The Ids of the owners to limit the search to, separated by a comma.
AncestorFolderIDs	String	The Ids of the folders to limit the search to, separated by a comma.