Microsoft Planner · Schema
Microsoft Planner Task
Represents a Planner task in Microsoft 365 as defined by the Microsoft Graph API v1.0. A task is contained in a plannerPlan and can be assigned to a plannerBucket within the plan. Each task can be assigned to users, categorized, and tracked for completion.
CollaborationMicrosoft 365ProductivityProject ManagementTask Management
Properties
| Name | Type | Description |
|---|---|---|
| @odata.etag | string | The ETag of the resource, used for optimistic concurrency control via the If-Match header on PATCH and DELETE operations. |
| id | string | Read-only unique identifier of the task. It is 28 characters long and case-sensitive. Format validation is performed by the service. |
| title | string | Title of the task. |
| planId | string | The ID of the plan to which the task belongs. Tasks cannot be created without specifying a plan. |
| bucketId | stringnull | The ID of the bucket to which the task belongs. The bucket must be in the same plan as the task. It is 28 characters long and case-sensitive. |
| assignments | object | The set of assignees the task is assigned to. Each key is the user ID of the assignee. |
| appliedCategories | object | The categories (labels) applied to the task. Category names are defined on the plan details. |
| priority | integer | Priority of the task. Valid range is 0-10, with 0 being highest priority. Values 0-1 map to 'urgent', 2-4 to 'important', 5-7 to 'medium', and 8-10 to 'low'. Planner sets 1 for urgent, 3 for important |
| percentComplete | integer | Percentage of task completion. When set to 100, the task is considered completed. |
| startDateTime | stringnull | Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. |
| dueDateTime | stringnull | Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. |
| completedDateTime | stringnull | Read-only. Date and time at which the percentComplete of the task was set to 100. ISO 8601 format, always in UTC. |
| completedBy | object | Read-only. Identity of the user that completed the task. |
| createdDateTime | string | Read-only. Date and time at which the task was created. ISO 8601 format, always in UTC. |
| createdBy | object | Read-only. Identity of the user that created the task. |
| hasDescription | boolean | Read-only. True if the details object of the task has a nonempty description, false otherwise. |
| conversationThreadId | stringnull | Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group. |
| orderHint | string | Hint used to order items of this type in a list view. The format is defined by the Planner order hints specification. |
| assigneePriority | string | Hint used to order items of this type in a list view when grouped by the user assigned to. |
| previewType | string | The type of preview that shows up on the task. |
| activeChecklistItemCount | integer | Read-only. Number of checklist items with value set to false, representing incomplete items. |
| checklistItemCount | integer | Read-only. Total number of checklist items present on the task. |
| referenceCount | integer | Read-only. Number of external references that exist on the task. |