Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
A task in the Planner Unified plans Graph API. planId routes the task back to its parent plan. Unlike the plannerTask/plannerTaskDetails split in the Planner Basic plans Graph API, a task in the Planner Unified plans Graph API has no separate details object - description, notes, checklist, assignments, and links are properties and sub-collections directly on the task.
Inherits from plannerDelta.
Use the listed methods to create, read, update, and delete tasks. You can create supported related objects in the same request as a task by using a deep insert. This doesn't imply standalone CRUD support for every related type, or that sending an array in a PATCH request replaces the collection.
Methods
| Method | Return type | Description |
|---|---|---|
| List | task collection | Get a list of the task objects and their properties. |
| Create | task | Create a new task object. |
| Get | task | Read the properties and relationships of task object. |
| Update | task | Update the properties of a task object. |
| Delete | None | Delete a task object. |
| List checklist | checklistItemV4 collection | Get a list of the checklistItemV4 objects and their properties. |
| List customFieldValues | customFieldValue collection | Get a list of the customFieldValue objects and their properties. |
| List links | contentLink collection | Get a list of the contentLink objects and their properties. |
| List messages | plannerChatMessage collection | Get a list of the plannerChatMessage objects and their properties. |
| List userAssignments | userAssignment collection | Get a list of the userAssignment objects and their properties. |
Properties
| Property | Type | Description |
|---|---|---|
| archivalInfo | plannerArchivalInfo | Service-populated information about whether the entity is archived, and when it was archived. Read-only. |
| bucketId | String | ID of the bucket that the task belongs to. |
| capabilities | taskCapability | Server-computed, read-only capability flags indicating which optional features are enabled for the entity. |
| completedBy | identitySet | Identity of the user who marked the task complete. Read-only. |
| completedDateTime | DateTimeOffset | Date and time the task was completed. Read-only. |
| creationInfo | creationInfo | Read-only creation metadata for the entity. |
| displayName | String | Title of the task. |
| dueDateTime | dateWithOptionalTime | Date and, optionally, time the task is due. |
| extensions | extensionFieldCollection | Custom extension field values set on the entity. Supports $select. |
| finishDateTime | dateWithOptionalTime | Date and, optionally, time the task was finished. |
| goalIds | String collection | IDs of the goals that the task is associated with. |
| hasChat | Boolean | Indicates whether the task has an associated chat. Read-only. |
| hasChildren | Boolean | Indicates whether the task has subtasks. Read-only. |
| id | String | The unique identifier of the entity. Read-only. Inherited from entity |
| isCritical | Boolean | Indicates whether the task is on the critical path, as computed from its dependencies. Read-only. |
| lastModifiedBy | identitySet | Identity of the user (or application) who last modified the entity. Read-only. |
| lastModifiedDateTime | DateTimeOffset | Date and time the entity was last modified. The value is represented in ISO 8601 format and is always in UTC time. Read-only. |
| notes | itemBody | Additional details or notes about the task. |
| parentTaskId | String | ID of the parent task, if this task is a subtask. |
| percentComplete | Int32 | Percentage of the task's completion, ranging from 0 to 100. |
| personalView | taskPersonalView | Per-user personal view settings for the task, such as My Day membership. |
| planId | String | ID of the plan that contains the task. Immutable after creation. |
| planView | taskPlanView | Task view settings scoped to the plan, such as applied category IDs. |
| priority | Int32 | Priority of the task. Supported values range from 0 (urgent) to 10 (low). |
| recurrence | plannerTaskRecurrence | Recurrence pattern for the task, if it repeats. |
| startDateTime | dateWithOptionalTime | Date and, optionally, time the task is scheduled to start. |
| status | plannerTaskStatus | Indicates progress on the task. The possible values are: notStarted, inProgress, completed, blocked, unknownFutureValue. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| checklist | checklistItemV4 collection | Checklist items on the task. Can be supplied when creating a task by using a deep insert. Nullable. |
| customFieldValues | customFieldValue collection | The collection of custom field values set on the task. Read-only. Nullable. |
| links | contentLink collection | Content links attached to the task. Can be supplied when creating a task by using a deep insert. Nullable. |
| messages | plannerChatMessage collection | The collection of chat messages associated with the task. Read-only. Nullable. |
| userAssignments | userAssignment collection | User assignments on the task. Can be supplied when creating a task by using a deep insert. Nullable. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.task",
"id": "String (identifier)",
"displayName": "String",
"planId": "String",
"bucketId": "String",
"goalIds": [
"String"
],
"status": "String",
"priority": "Int32",
"percentComplete": "Int32",
"startDateTime": {
"@odata.type": "microsoft.graph.dateWithOptionalTime"
},
"dueDateTime": {
"@odata.type": "microsoft.graph.dateWithOptionalTime"
},
"finishDateTime": {
"@odata.type": "microsoft.graph.dateWithOptionalTime"
},
"notes": {
"@odata.type": "microsoft.graph.itemBody"
},
"creationInfo": {
"@odata.type": "microsoft.graph.creationInfo"
},
"lastModifiedBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"lastModifiedDateTime": "String (timestamp)",
"completedBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"completedDateTime": "String (timestamp)",
"recurrence": {
"@odata.type": "microsoft.graph.plannerTaskRecurrence"
},
"archivalInfo": {
"@odata.type": "microsoft.graph.plannerArchivalInfo"
},
"planView": {
"@odata.type": "microsoft.graph.taskPlanView"
},
"personalView": {
"@odata.type": "microsoft.graph.taskPersonalView"
},
"parentTaskId": "String",
"hasChildren": "Boolean",
"isCritical": "Boolean",
"hasChat": "Boolean",
"capabilities": {
"@odata.type": "microsoft.graph.taskCapability"
},
"extensions": {
"@odata.type": "microsoft.graph.extensionFieldCollection"
}
}