{"id":11025,"date":"2022-08-11T13:20:13","date_gmt":"2022-08-11T20:20:13","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/?p=11025"},"modified":"2022-08-11T13:24:56","modified_gmt":"2022-08-11T20:24:56","slug":"new-features-in-microsoft-graph-to-do-apis-and-retirement-of-the-tasks-beta-api","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/new-features-in-microsoft-graph-to-do-apis-and-retirement-of-the-tasks-beta-api\/","title":{"rendered":"New features in Microsoft Graph To Do APIs and retirement of the Tasks (Beta) API"},"content":{"rendered":"

We are committed to providing a rich task infrastructure through the Microsoft Graph To-Do tasks APIs so partners and customers can build delightful task experiences for their users. We\u2019ve been listening to customers\u2019 requests for new features, and we\u2019re excited to share that we\u2019re releasing new capabilities in the To Do APIs, including file attachments on tasks, support for categories, and more.<\/p>\n

Attachments<\/h2>\n

We\u2019ve introduced support for fetching, uploading and deleting file attachments<\/a> on a task on the beta endpoint. There are two methods to upload attachments on a task:<\/p>\n

    \n
  1. To attach files of any size, create an upload session<\/a>, and iteratively use PUT call to upload ranges of bytes of the file until you have uploaded the entire file. See attach files to a To Do task<\/a> for an example.<\/li>\n
  2. If the file size is under 3 MB, you can do a single POST on the attachment’s navigation property of todoTask<\/a>; See create attachment<\/a> for an example.<\/li>\n<\/ol>\n

    Categories<\/h2>\n

    Categories lets you easily tag or label tasks in To Do and it has been one of the top requests from partners. We recently released categories support on the Microsoft Graph v1 endpoint.<\/p>\n

    Now, developers will get the categories<\/strong> as part of the response when querying for users\u2019 task. Each category corresponds to the displayName<\/strong> property of an outlookCategory<\/a> that the user has defined.<\/p>\n

    Example<\/span><\/p>\n

    GET https:\/\/graph.microsoft.com\/v1.0\/me\/todo\/lists\/<list-id>\/tasks\/<task-id><\/span>\r\nHTTP\/1.1 200 OK\r\n        {\r\n            \"importance\": \"high\",\r\n            \"isReminderOn\": false,\r\n            \"status\": \"completed\",\r\n            \"title\": \"Review Q1 marketing\",\r\n            \"createdDateTime\": \"2022-04-28T12:18:39.2889451Z\",\r\n            \"lastModifiedDateTime\": \"2022-06-01T04:22:16.0704279Z\",\r\n            \"categories\": [\r\n                \"Planning\",\r\n                \"Urgent\"\r\n],\r\n            \"id\": \"AAMj1YgAGEuIMbwAAAA==\",\r\n            \"body\": {\r\n                \"content\": \"\",\r\n                \"contentType\": \"text\"\r\n            }\r\n            }\r\n<\/pre>\n
    checklistItems<\/h2>\n
    To Do allows breaking down a complex task into more actionable, smaller steps. Now, you can also create, read, update, and delete steps using the checklistItem<\/a> on the Microsoft Graph v1 endpoint.<\/p>\n\n\n\n\n\n\n\n
    Attributes<\/td>\nType<\/td>\nDescription<\/td>\n<\/tr>\n
    checkedDateTime<\/td>\nDateTimeOffset<\/td>\nThe date and time when the checklistItem was finished.<\/td>\n<\/tr>\n
    createdDateTime<\/td>\nDateTimeOffset<\/td>\nThe date and time when the checklistItem was created.<\/td>\n<\/tr>\n
    displayName<\/td>\nString<\/td>\nField indicating the title of checklistItem.<\/td>\n<\/tr>\n
    isChecked<\/td>\nBoolean<\/td>\nState indicating whether the item is checked off or not.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
     <\/p>\n
    Examples<\/h3>\n
    Retrieve checklistitems as part of Tasks resource<\/strong><\/h4>\n
    GET https:\/\/graph.microsoft.com\/v1.0\/me\/todo\/lists\/<list-id>\/tasks\/<task-id><\/span>\r\n\r\nHTTP\/1.1 200 OK\r\n        {\r\n            \"importance\": \"normal\",\r\n            \"isReminderOn\": false,\r\n            \"status\": \"notStarted\",\r\n            \"title\": \"Review Q1 marketing\",\r\n            \"createdDateTime\": \"2022-06-14T04:52:14.3497205Z\",\r\n            \"lastModifiedDateTime\": \"2022-06-14T04:54:37.3021207Z\",\r\n            \"categories\": [],\r\n            \"id\": \"AQMkADAwA==\",\r\n            \"body\": {\r\n                \"content\": \"\",\r\n                \"contentType\": \"text\"\r\n            },\r\n            \"checklistItems\": [\r\n                {\r\n                    \"displayName\": \"Review introduction\",\r\n                    \"createdDateTime\": \"2022-06-14T04:53:25.0246583Z\",\r\n                    \"isChecked\": false,\r\n                    \"id\": \"f341acf2-b3e2-45ae-883d-b6490d240735\"\r\n                },\r\n                {\r\n                    \"displayName\": \"Share with colleagues\",\r\n                    \"createdDateTime\": \"2022-06-14T04:54:27.7648563Z\",\r\n                    \"isChecked\": false,\r\n                    \"id\": \"9357655e-577b-41e7-ada4-8f90692b84ef\"\r\n                }\r\n            ]\r\n        }\r\n<\/pre>\n
    Get a specified checklistItem <\/strong><\/h4>\n
    GET https:\/\/graph.microsoft.com\/v1.0\/me\/todo\/lists\/<list-id>\/tasks\/<task-id>\/checklistItems\/<checklistItem-id><\/span>\r\n\r\nHTTP\/1.1 200 OK\r\n                {\r\n                    \"displayName\": \"Review introduction\",\r\n                    \"createdDateTime\": \"2022-06-14T04:53:25.0246583Z\",\r\n                    \"isChecked\": false,\r\n                    \"id\": \"f341acf2-b3e2-45ae-883d-b6490d240735\"\r\n                }\r\n<\/pre>\n
    Create a checklistItem<\/strong><\/h4>\n
    POST https:\/\/graph.microsoft.com\/v1.0\/me\/todo\/lists\/<list-id>\/tasks\/<task-id>\/checklistItems<\/span>\r\n{\r\n     \"displayName\": \"Get feedback\",\r\n}\r\n\r\nHTTP\/1.1 201 Created\r\n{\r\n    \"displayName\": \"Get feedback\",\r\n    \"createdDateTime\": \"2022-06-14T05:07:45.6021029Z\",\r\n    \"isChecked\": false,\r\n    \"id\": \"c55af287-11ce-4db9-beff-f9427963f4a1\"\r\n}\r\n<\/pre>\n
    For more information and examples, see the detailed documentation for checklistItems<\/a>.<\/p>\n
    StartDateTime<\/h2>\n
    We are introducing a new property in beta, startDateTime, that shows the date in a specified time zone at which the task is scheduled to start. You can see this property while querying users To Do tasks.<\/p>\n
    Example<\/h3>\n
    GET https:\/\/graph.microsoft.com\/beta\/me\/todo\/lists\/<list-id>\/tasks\/<task-id><\/span>\r\nHTTP\/1.1 200 OK\r\n        {\r\n            \"importance\": \"high\",\r\n            \"isReminderOn\": false,\r\n            \"status\": \"completed\",\r\n            \"title\": \"Review Q1 marketing\",\r\n            \"createdDateTime\": \"2022-04-28T12:18:39.2889451Z\",\r\n            \"lastModifiedDateTime\": \"2022-06-01T04:22:16.0704279Z\",\r\n            \"categories\": [\r\n                \"Planning\",\r\n                \"Urgent\"\r\n],\r\n     \"startDateTime\": { \r\n  \"dateTime\": \"2012-07-23T07:00:00.0000000\", \r\n  \"timeZone\": \"UTC\" \r\n      }, \r\n            \"id\": \"AAMj1YgAGEuIMbwAAAA==\",\r\n            \"body\": {\r\n                \"content\": \"\",\r\n                \"contentType\": \"text\"\r\n            }\r\n            }\r\n<\/pre>\n
    Retirement of Tasks (preview) APIs at me\/tasks<\/h2>\n
    The to-do API set built on baseTask<\/a> was retired on May 31, 2022 and will stop returning data on August 31, 2022<\/strong>. We made this change to bring clarity for developers around which APIs to use to access users\u2019 tasks.<\/p>\n
    What do I need to do?<\/strong><\/h3>\n
    If you\u2019re testing or building an application with any of the below resource, please plan to use the recommended resources from To Do tasks API<\/a>.<\/p>\n\n\n\n\n\n\n
    Deprecated resources<\/strong><\/td>\nRecommended resource<\/strong><\/td>\n<\/tr>\n
    baseTaskList<\/a>, <\/strong>taskList<\/a>, <\/strong>wellKnownTaskList<\/a><\/td>\ntodoTaskList<\/a><\/td>\n<\/tr>\n
    baseTask<\/a>, task<\/a><\/td>\ntodoTask <\/a><\/td>\n<\/tr>\n
    linkedResource_v2<\/a><\/td>\nlinkedResource<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    \u00a0<\/strong><\/p>\n
    Thank you for\u00a0continuing\u00a0with us on our journey as we continue to improve productivity for everyone. If you have any feedback, suggestions or question, email us<\/a> or\u00a0let us know on our feedback<\/a> page.<\/p>\n
    Happy coding!<\/p>\n","protected":false},"excerpt":{"rendered":"
    Learn about the new features in To Do tasks API and the retirement of the Tasks (Beta) API in Microsoft Graph.<\/p>\n","protected":false},"author":69077,"featured_media":6844,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[3],"tags":[12,156],"class_list":["post-11025","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-microsoft-graph","tag-outlook","tag-to-do-api"],"acf":[],"blog_post_summary":"
    Learn about the new features in To Do tasks API and the retirement of the Tasks (Beta) API in Microsoft Graph.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts\/11025","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/users\/69077"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/comments?post=11025"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts\/11025\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/media\/6844"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/media?parent=11025"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/categories?post=11025"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/tags?post=11025"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}