Tasks
Allows users to manage tasks, plans, and initiatives.
Table Specific Information
Select
The add-in will use the Microsoft Planner API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the add-in.
- TaskId supports the '=' operator.
- PlanId supports the '=' operator.
- UserId supports the '=' operator.
- BucketId supports the '=' operator.
For example, the following queries are processed server side:
SELECT * FROM Tasks WHERE TaskId = 'BCrvyMoiLEafem-3RxIESmUAHbLK' SELECT * FROM Tasks WHERE PlanId = 'nETc1IDpYk3r3e317w8TxGmUAGFWC' SELECT * FROM Tasks WHERE UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe' SELECT * FROM Tasks WHERE BucketId = 'qIguxctMLEGHYhmgSVGSNGUAAZOZ'
Insert
Required fields for an insert are: title and planId.
Optional: bucketId.
INSERT INTO Tasks (title, planId) VALUES ('test44', 'nETc1IDpYkmb1E17w8TxGmUAGFWC') INSERT INTO Tasks (title, planId, bucketId) VALUES ('test44', 'nETc1IDpYkmb1E17w8TxGmUAGFWC', 'ZfzKVriNQ0yzR4IqJp-8FWUADq0Y')
Update
Microsoft Planner allows updates for the title, bucketId, percentComplete, assigneePriority, conversationThreadId, orderHint, dueDateTime and startDateTime columns.
UPDATE Tasks SET assigneePriority = '8377555 94446!', bucketId = 'rWpNKGmHukm84GaiDF_ZL2UAOlMj', conversationThreadId = 'AAQkADlmMzE1ZGIzLWY3OTctNDcyMy1iYmNlLWNlZmNlZTc5', dueDateTime = '2019-09-30T14:49:23', orderHint = '343d 454fd!', startDateTime = '2019-07-31T14:49:23.269', title = 'updatedTask', percentComplete = '35' WHERE TaskId = '7POTl5DUfkOsgzptPrzdzGUAHy1z'
Delete
Tasks can be deleted by providing TaskId.
DELETE FROM Tasks WHERE TaskId = 'BCrvyMoiLEafem-3RxIESmUAHbLK'
Columns
Name | Type | ReadOnly | Description |
TaskId [KEY] | String | False |
The unique identifier of the task. |
activeChecklistItemCount | Int | False |
Specifies the active checklist item count. |
appliedCategories | String | False |
The categories to which the task has been applied. |
assigneePriority | String | False |
The hint used to order items of this type in a list view. |
assignments | String | False |
The set of assignees the task is assigned to. |
bucketId | String | False |
The bucket ID to which the task belongs. |
checklistItemCount | Int | False |
The number of checklist items that are present on the task. |
completedBy_application_displayName | String | False |
Label Completed By Application Display Name corresponds to this field. |
completedBy_application_id | String | False |
Label Completed By Application ID corresponds to this field. |
completedDateTime | Datetime | False |
Specifies the completed date and time. |
conversationThreadId | String | False |
The thread ID of the conversation on the task. |
createdBy_application_displayName | String | False |
Label Created By Application Display Name corresponds to this field. |
createdBy_application_id | String | False |
Label Created By Application ID corresponds to this field. |
createdDateTime | Datetime | False |
Specifies the date and time at which the task is created. |
dueDateTime | Datetime | False |
Specifies the date and time at which the task is due. |
hasDescription | Bool | False |
The value is true if the details object of the task has a nonempty description and false otherwise. |
orderHint | String | False |
Typically used to set the relative order of items in the task. |
percentComplete | Int | False |
Specifies how much of the task has been completed, given in a percentage. |
planId | String | False |
The unique identifier of the plan. |
previewType | String | False |
This sets the type of preview that shows up on the task. |
priority | Int | False |
The priority of the task. |
referenceCount | Int | False |
The number of external references that exist on the task. |
startDateTime | Datetime | False |
Specifies the date and time at which the task starts. |
title | String | False |
The title of the task item. |
assignedToTaskBoardFormat_id | String | True |
Typically used to render the task correctly in the task board view when grouped by assignedTo. |
bucketTaskBoardFormat_id | String | True |
Typically used to render the task correctly in the task board view when grouped by bucket. |
details_id | String | True |
Specifies more details about the task. |
progressTaskBoardFormat_id | String | True |
Typically used to render the task correctly in the task board view when grouped by progress. |
UserId | String | False |
Unique identifier of the user. |
Etag | String | False |
Unique identifier for a resource version. |
GroupId | String | False |
Unique identifier of the group. |