todoTaskList resource type

Article
09/02/2021

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 list in Microsoft To Do that contains one or more todoTask resources.

In To Do, there are built-in task lists such as Flagged emails and Tasks which cannot be renamed or deleted. You can, however, create additional task lists.

This resource supports

Adding your data to custom properties as open extensions
Using delta query to track incremental additions, deletions and updates.

Methods

Method	Return type	Description
List task lists	todoTaskList collection	Get all the todoTaskList in the user's mailbox.
Create task list	todoTaskList	Create a todoTaskList in the user's mailbox.
Get task list	todoTaskList	Read the properties and relationships of the specified todoTaskList.
Update task list	todoTaskList	Update the writable properties of the specified todoTaskList.
Delete task list	None	Delete the specified todoTaskList .
List tasks	todoTask collection	Get all the todoTask resources in the specified list.
Create task	todoTask	Create a todoTask in the specified task list.

Properties

Property	Type	Description
displayName	String	The name of the task list.
id	String	The identifier of the task list, unique in the user's mailbox. Read-only. Inherited from entity
isOwner	Boolean	True if the user is owner of the given task list.
isShared	Boolean	True if the task list is shared with other users
wellknownListName	wellknownListName	Property indicating the list name if the given list is a well-known list. 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. Do not use.

Relationships

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

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.todoTaskList",
  "id": "String (identifier)",
  "displayName": "String",
  "isOwner": "Boolean",
  "isShared": "Boolean",
  "wellknownListName": "String"
}

Share via