task 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.

A Planner V4 task. planId routes the task back to its parent plan. Unlike the V3 plannerTask/plannerTaskDetails split, a V4 task has no separate details object - description, notes, checklist, assignments, and links are properties and sub-collections directly on the task.

Inherits from plannerDelta.

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.
Create checklistItemV4	checklistItemV4	Create a new checklistItemV4 object.
List customFieldValues	customFieldValue collection	Get a list of the customFieldValue objects and their properties.
Create customFieldValue	customFieldValue	Create a new customFieldValue object.
List links	contentLink collection	Get a list of the contentLink objects and their properties.
Create contentLink	contentLink	Create a new contentLink object.
List messages	plannerChatMessage collection	Get a list of the plannerChatMessage objects and their properties.
Create plannerChatMessage	plannerChatMessage	Create a new plannerChatMessage object.
List userAssignments	userAssignment collection	Get a list of the userAssignment objects and their properties.
Create userAssignment	userAssignment	Create a new userAssignment object.

Properties

Property	Type	Description
archivalInfo	plannerArchivalInfo	Information about whether the entity is archived, and when it was archived.
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.
completedDateTime	DateTimeOffset	Date and time the task was completed.
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.
hasChildren	Boolean	Indicates whether the task has subtasks.
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.
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	The collection of checklist items on the task. Read-only. Nullable.
customFieldValues	customFieldValue collection	The collection of custom field values set on the task. Read-only. Nullable.
links	contentLink collection	The collection of content links attached to the task. Read-only. Nullable.
messages	plannerChatMessage collection	The collection of chat messages associated with the task. Read-only. Nullable.
userAssignments	userAssignment collection	The collection of user assignments on the task. Read-only. 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"
  }
}