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