Tasks
Manages individual tasks, providing functionality for planning, assigning, and tracking initiatives across various projects.
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'
If no filter is provided, the add-in behaves differently based on AuthScheme. Authenticating as a user reads the user's assigned tasks. When authenticating as a service principal, the add-in instead queries Users and reads tasks assigned to every user.
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 |
A unique identifier assigned to each task, ensuring it can be distinctly referenced. |
| activeChecklistItemCount | Int | False |
The count of checklist items associated with the task that are not marked as completed. |
| appliedCategories | String | False |
A list of categories or tags that have been applied to this task for organizational purposes. |
| assigneePriority | String | False |
A priority value used to determine the relative order of tasks in a list view for assignees. |
| assignments | String | False |
A collection representing the users or groups assigned to work on this task. |
| bucketId | String | False |
The unique identifier of the bucket within the plan where this task is grouped. |
| checklistItemCount | Int | False |
The total number of checklist items that are part of this task, including completed and active items. |
| completedBy_application_displayName | String | False |
The display name of the application that marked this task as completed. |
| completedBy_application_id | String | False |
The unique identifier of the application that marked this task as completed. |
| completedDateTime | Datetime | False |
The exact date and time when the task was marked as completed. |
| conversationThreadId | String | False |
The identifier of the conversation thread linked to this task, if applicable. |
| createdBy_application_displayName | String | False |
The display name of the application that created this task. |
| createdBy_application_id | String | False |
The unique identifier of the application that created this task. |
| createdDateTime | Datetime | False |
The date and time when the task was created. |
| dueDateTime | Datetime | False |
The deadline date and time by which the task should be completed. |
| hasDescription | Bool | False |
Indicates whether the task contains a detailed description (true) or not (false). |
| orderHint | String | False |
A hint value used to determine the task's order relative to others in its list or view. |
| percentComplete | Int | False |
The percentage indicating the extent to which the task has been completed. |
| planId | String | False |
The unique identifier of the plan that this task belongs to. |
| previewType | String | False |
Defines the type of visual preview (for example, image, document) displayed on the task. |
| priority | Int | False |
An integer value representing the priority level of the task, with lower values indicating higher priority. |
| referenceCount | Int | False |
The total count of external references, such as links or documents, associated with this task. |
| startDateTime | Datetime | False |
The scheduled start date and time for this task. |
| title | String | False |
The descriptive title or name of the task. |
| assignedToTaskBoardFormat_id | String | True |
A unique identifier used for rendering the task in task board views when grouped by assignees. |
| bucketTaskBoardFormat_id | String | True |
A unique identifier used for rendering the task in task board views when grouped by buckets. |
| details_id | String | True |
The identifier for additional details associated with this task. |
| progressTaskBoardFormat_id | String | True |
A unique identifier used for rendering the task in task board views when grouped by progress status. |
| UserId | String | False |
The unique identifier of the user associated with this task. |
| Etag | String | False |
An identifier for the specific version of the task resource, used for tracking changes. |
| GroupId | String | False |
The unique identifier of the group associated with this task. |