plannerTask resource type
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.
Represents a planner task in Microsoft 365. A planner task is contained in a plan and can be assigned to a bucket in a plan. Each task object has a details object that can contain more information about the task. For more information about relationships between group, plan, and task, see Use the planner REST API.
Methods
| Method | Return Type | Description |
|---|---|---|
| Create | plannerTask | Create a plannerTask object. |
| Get | plannerTask | Read the properties and relationships of plannerTask object. |
| Update | plannerTask | Update a plannerTask object. |
| Delete | None | Delete a plannerTask object. |
| Get delta | plannerTask collection | Get newly created, updated, or deleted plannerTask objects in either a plannerPlan or assigned to the signed-in user without having to perform a full read of the entire resource collection. |
Properties
| Property | Type | Description |
|---|---|---|
| activeChecklistItemCount | Int32 | The number of checklist items with value set to false, representing incomplete items. |
| appliedCategories | plannerAppliedCategories | The categories to which the task is applied. See plannerAppliedCategories resource type for possible values. |
| archivalInfo | plannerArchivalInfo | Read-only. Nullable. Contains information about who archived or unarchived the task and why. |
| assigneePriority | String | A hint that is used to order items of this type in a list view. For more information, see Using order hints in planner. |
| assignments | plannerAssignments | The set of assignees the task is assigned to. |
| bucketId | String | Bucket ID to which the task belongs. The bucket needs to be in the same plan as the task. The value of the bucketId property is 28 characters long and case-sensitive. Format validation is done on the service. |
| checklistItemCount | Int32 | The number of checklist items that are present on the task. |
| completedBy | identitySet | The identity of the user that completed the task. |
| completedDateTime | DateTimeOffset | Read-only. The date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
| conversationThreadId | String | The thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group. |
| createdBy | identitySet | The identity of the user who created the task. |
| createdDateTime | DateTimeOffset | Read-only. The date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
| creationSource | plannerTaskCreation | Information about the origin of the task. |
| dueDateTime | DateTimeOffset | The 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. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
| hasDescription | Boolean | Read-only. This value is true if the details object of the task has a nonempty description. Otherwise,false. |
| id | String | Read-only. The unique identifier of the task. The value of this property is 28 characters long and case-sensitive. Format validation is done on the service. |
| isArchived | Boolean | Read-only. If set to true, the task is archived. An archived task is read-only. |
| isOnMyDay | Boolean | Indicates whether to show this task in the MyDay view. If true, it shows the task. |
| isOnMyDayLastModifiedDate | Date | Read-only. The date on which task is added to or removed from MyDay. |
| orderHint | String | The hint used to order items of this type in a list view. For more information, see Using order hints in plannern. |
| percentComplete | Int32 | The percentage of task completion. When set to 100, the task is completed. |
| priority | Int32 | The priority of the task. Valid values are between 0 and 10, inclusive. Larger values indicate lower priority. For example, 0 has the highest priority and 10 has the lowest priority. Currently, planner interprets values 0 and 1 as "urgent", 2 and 3 and 4 as "important", 5, 6, and 7 as "medium", and 8, 9, and 10 as "low". Currently, planner sets the value 1 for "urgent", 3 for "important", 5 for "medium", and 9 for "low". |
| planId | String | Plan ID to which the task belongs. |
| previewType | String | The type of preview that shows up on the task. Possible values are: automatic, noPreview, checklist, description, reference. |
| recurrence | plannerTaskRecurrence | Defines active or inactive recurrence for the task. null when the recurrence has never been defined for the task. |
| referenceCount | Int32 | Number of external references that exist on the task. |
| specifiedCompletionRequirements | plannerTaskCompletionRequirements | Indicates all the requirements specified on the plannerTask. Possible values are: none, checklistCompletion, unknownFutureValue, formCompletion, approvalCompletion. Read-only. You must use the Prefer: include-unknown-enum-members request header to get the following values in this evolvable enum: formCompletion, approvalCompletion. The plannerTaskCompletionRequirementDetails in plannerTaskDetails has details of the requirements specified, if any. |
| startDateTime | DateTimeOffset | 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. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
| title | String | Title of the task. |
plannerTaskCompletionRequirements values
| Member | Description |
|---|---|
| none | No requirement. |
| checklistCompletion | Some or all of the checklist items are required to be checked. |
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
| formCompletion | Some or all of the forms must be submitted to complete the planner task. |
| approvalCompletion | Approval is required. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| assignedToTaskBoardFormat | plannerAssignedToTaskBoardTaskFormat | Read-only. Nullable. Used to render the task correctly in the task board view when grouped by assignedTo. |
| bucketTaskBoardFormat | plannerBucketTaskBoardTaskFormat | Read-only. Nullable. Used to render the task correctly in the task board view when grouped by bucket. |
| details | plannerTaskDetails | Read-only. Nullable. More details about the task. |
| progressTaskBoardFormat | plannerProgressTaskBoardTaskFormat | Read-only. Nullable. Used to render the task correctly in the task board view when grouped by progress. |
JSON representation
The following JSON representation shows the resource type.
{
"activeChecklistItemCount": "Int32",
"appliedCategories": {"@odata.type": "microsoft.graph.plannerAppliedCategories"},
"assigneePriority": "String",
"assignments": {"@odata.type": "microsoft.graph.plannerAssignments"},
"bucketId": "String",
"checklistItemCount": "Int32",
"completedBy": {"@odata.type": "microsoft.graph.identitySet"},
"completedDateTime": "String (timestamp)",
"conversationThreadId": "String",
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"dueDateTime": "String (timestamp)",
"hasDescription": "Boolean",
"id": "String (identifier)",
"isOnMyDay": "Boolean",
"isOnMyDayLastModifiedDate": "Date",
"orderHint": "String",
"percentComplete": "Int32",
"planId": "String",
"previewType": "String",
"priority": "Int32",
"recurrence": {"@odata.type": "microsoft.graph.plannerTaskRecurrence"},
"referenceCount": "Int32",
"specifiedCompletionRequirements": "String",
"startDateTime": "String (timestamp)",
"title": "String"
}