baseTask resource type (deprecated)
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.
An abstract type that represents a task, such as a piece of work or personal item, that can be tracked and completed.
This is a base type inherited by the task resource.
Methods
| Method | Return type | Description |
|---|---|---|
| List baseTasks | baseTask collection | Get a list of the baseTask objects and their properties. |
| Create baseTask | baseTask | Create a new baseTask object. |
| Get baseTask | baseTask | Read the properties and relationships of a baseTask object. |
| Update baseTask | baseTask | Update the properties of a baseTask object. |
| Delete baseTask | None | Deletes a baseTask object. |
| move | baseTask | Move the message to a different list. |
| delta | baseTask collection | Get a set of baseTask objects that have been added, deleted, or updated in a specified list. |
| List checklistItems | checklistItem collection | Get the checklistItem resources from the checklistItems navigation property. |
| Create checklistItem | checklistItem | Create a new checklistItem object. |
| List linkedResources | linkedResource_v2 collection | Get the linkedResource_v2 resources from the linkedResources navigation property. |
| Create linkedResource_v2 | linkedResource_v2 | Create a new linkedResource_v2 object. |
Properties
| Property | Type | Description |
|---|---|---|
| textBody | String | The task body in text format that typically contains information about the task. |
| bodyLastModifiedDateTime | DateTimeOffset | The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'. |
| completedDateTime | DateTimeOffset | The date when the task was finished. |
| createdDateTime | DateTimeOffset | The date and time when the task was created. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'. |
| displayName | String | The name of the task. |
| dueDateTime | dateTimeTimeZone | The date in the specified time zone that the task is to be finished. |
| id | String | Unique identifier for the task. By default, this value will not change if a task is moved from one list to another. |
| importance | importance | The importance of the task. Possible values are: low, normal, high. The possible values are: low, normal, high. |
| lastModifiedDateTime | DateTimeOffset | The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'. |
| viewpoint | taskViewpoint | Properties that are personal to a user such as reminderDateTime and categories. |
| recurrence | patternedRecurrence | The recurrence pattern for the task. |
| startDateTime | dateTimeTimeZone | The date in the specified time zone when the task is to begin. |
| status | taskStatus_v2 | Indicates the state or progress of the task. Possible values are: notStarted, inProgress, completed,unknownFutureValue. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| checklistItems | checklistItem collection | A collection of smaller subtasks linked to the more complex parent task. |
| extensions | extension collection | The collection of open extensions defined for the task . |
| linkedResources | linkedResource_v2 collection | A collection of resources linked to the task. |
| parentList | baseTaskList | The list which contains the task. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.baseTask",
"textBody": "String",
"createdDateTime": "String (timestamp)",
"lastModifiedDateTime": "String (timestamp)",
"bodyLastModifiedDateTime": "String (timestamp)",
"completedDateTime": "String (timestamp)",
"dueDateTime": {
"@odata.type": "microsoft.graph.dateTimeTimeZone"
},
"startDateTime": {
"@odata.type": "microsoft.graph.dateTimeTimeZone"
},
"importance": "String",
"recurrence": {
"@odata.type": "microsoft.graph.patternedRecurrence"
},
"displayName": "String",
"status": "String",
"viewpoint": {
"@odata.type": "microsoft.graph.taskViewpoint"
},
"id": "String (identifier)"
}