wellKnownTaskList resource type (deprecated)

Article
07/23/2024

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.

Caution

The to-do API set built on baseTask was deprecated on May 31, 2022, and stopped returning data on August 31, 2022. Use the todoTask API instead.

A built-in task list that can't be renamed or deleted. To Do has two built-in lists, flagged email and tasks list.

This resource supports adding your data to custom properties as open extensions

Inherits from baseTaskList.

Methods

Method	Return type	Description
List base task lists	wellKnownTaskList collection	Get a list of the wellKnownTaskList objects and their properties.
Get base task list	wellKnownTaskList	Read the properties and relationships of a wellKnownTaskList object.
List base tasks	baseTask collection	Get the baseTask resources from the tasks navigation property.
Create base task	baseTask	Create a new baseTask object.

Properties

Property	Type	Description
displayName	String	The name of the task list. Inherited from baseTaskList.
id	String	The identifier of the task list, unique in the user's mailbox. Read-only. Inherited from baseTaskList.
wellKnownListName	wellKnownListName_v2	Property indicating the list name if the given list is a well-known list. The possible values are: `none`, `defaultList`, `flaggedEmails`, `unknownFutureValue`.

wellknownListName values

Member	Description
none	User created list.
defaultList	Built-in tasks list.
flaggedEmails	Built-in flagged email list. Tasks from flagged emails are present in this list.
unknownFutureValue	Evolvable enumeration sentinel value. Don't use.

Relationships

Relationship	Type	Description
extensions	extension collection	The collection of open extensions defined for the task list. Nullable. Inherited from baseTaskList
tasks	baseTask collection	The tasks in this task list. Read-only. Nullable. Inherited from baseTaskList

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.wellKnownTaskList",
  "displayName": "String",
  "id": "String (identifier)",
  "wellKnownListName": "String"
}

Share via