Collaborations
Create, update, delete, and query the available Collaborations in Box.
Table Specific Information
Collaborations are connections between Folders and Groups; i.e., one Group could be collaborating on a specific Collaboration.
Select
To query the Collaborations table, specify an Id, FolderId, or a GroupId.
SELECT * FROM Collaborations WHERE Id = '123'
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 you need to 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
Only the Role and the Status of the Collaboration can be updated.
UPDATE Collaborations SET Role = 'viewer', Status = 'accepted' WHERE Id = '100'
Delete
Collaborations can be deleted by providing an Id and issuing a DELETE statement.
DELETE FROM Collaborations WHERE Id = '100'
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The Id of the collaboration. |
| CreatedAt | Datetime | True |
The date the collaboration was created at. |
| ModifiedAt | Datetime | True |
The date the collaboration was modified at. |
| AcknowledgedAt | Datetime | True |
The date the collaboration was acknowledged. |
| CreatedById | String | True |
The Id of the user that created the collaboration. |
| Status | String | False |
The status of the collaboration. |
| Role | String | False |
The role of the user or group of the collaborator. Allowed values are editor, viewer, previewer, uploader, previewer uploader, viewer uploader, co-owner, or owner |
| ItemId | String | False |
The Id of the item the collaboration is related to. |
| ItemType | String | False |
The type of the item the collaboration is related to. |
| AccessibleById | String | False |
The Id of the group/user that can access this collaboration. |
| AccessibleByType | String | False |
The type of the entity of Accessible_By_Id. The allowed values are group, user. |
| AccessibleByLogin | String | False |
The login of the the Accessible_By_Id. |
| 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 |
| FolderId | String |
The Id of the folder the collaboration is related to. |
| GroupId | String |
The Id of the group the collaboration is related to. |