Edit

Share via

checklistItem resource type

  • Article

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

Existing apps that use this feature with baseTask or baseTaskList should be updated, as the to-do API set built on these resources is deprecated as of May 31, 2022. That API set will stop returning data on August 31, 2022. Please use the API set built on todoTask.

Represents a subtask in a bigger todoTask. ChecklistItem allows breaking down a complex task into more actionable, smaller tasks.

Methods

Method Return type Description
List checklistItem collection Get a list of the checklistItem objects and their properties associated to a specified todoTask.
Create checklistItem Create a new checklistItem object associated to a specified todoTask.
List checklistItems (deprecated) checklistItem collection Get a list of the checklistItem objects and their properties associated to a specified baseTask.
Create checklistItem (deprecated) checklistItem Create a new checklistItem object associated to a specified baseTask.
Get checklistItem Read the properties and relationships of a checklistItem object.
Update checklistItem Update the properties of a checklistItem object.
Delete None Delete a checklistItem object.

Properties

Property Type Description
checkedDateTime DateTimeOffset The date and time when the checklistItem was finished.
createdDateTime DateTimeOffset The date and time when the checklistItem was created.
displayName String Indicates the title of the checklistItem.
id String Server generated ID for the checkListItem
isChecked Boolean State that indicates whether the item is checked off or not.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.checklistItem",
  "createdDateTime": "String (timestamp)",
  "checkedDateTime": "String (timestamp)",
  "displayName": "String",
  "id": "String (identifier)",
  "isChecked": "Boolean"
}