{"id":9605,"date":"2022-02-17T13:16:53","date_gmt":"2022-02-17T21:16:53","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/?p=9605"},"modified":"2022-10-12T16:11:29","modified_gmt":"2022-10-12T23:11:29","slug":"breaking-changes-in-the-microsoft-graph-tasks-api-beta","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/breaking-changes-in-the-microsoft-graph-tasks-api-beta\/","title":{"rendered":"Breaking changes in the Microsoft Graph Tasks API (beta)\u00a0"},"content":{"rendered":"<p><span data-contrast=\"auto\">For the past several months we\u2019ve offered developers preview access to our new Tasks API on the beta endpoint of Microsoft Graph. The Tasks API helps bring users\u2019 tasks from multiple sources such as Outlook emails, Teams chats, Office documents into one single place. However, as is sometimes the case with pre-production APIs, we\u2019re making a few necessary changes to property names and types to align them with similar properties elsewhere in Microsoft Graph. Note that these are breaking changes that will impact developers whose solutions are currently calling the <a href=\"https:\/\/docs.microsoft.com\/en-us\/graph\/api\/resources\/tasks-overview?view=graph-rest-beta\">To Do API<\/a>.<\/span><\/p>\n<h2><span data-contrast=\"auto\">Breaking changes to the Tasks API<\/span><\/h2>\n<ul>\n<li data-leveltext=\"\uf0b7\" data-font=\"Symbol\" data-listid=\"1\" aria-setsize=\"-1\" data-aria-posinset=\"1\" data-aria-level=\"1\"><span data-contrast=\"auto\">The <\/span><b><span data-contrast=\"auto\">personalProperties<\/span><\/b><span data-contrast=\"auto\"> property of baseTask resource is now named <\/span><b><span data-contrast=\"auto\">viewpoint<\/span><\/b><span data-ccp-props=\"{&quot;201341983&quot;:0,&quot;335559739&quot;:160,&quot;335559740&quot;:259}\">\u00a0<\/span><\/li>\n<li data-leveltext=\"\uf0b7\" data-font=\"Symbol\" data-listid=\"1\" aria-setsize=\"-1\" data-aria-posinset=\"2\" data-aria-level=\"1\">The <b><span data-contrast=\"auto\">reminderDatetime<\/span><\/b><span data-contrast=\"auto\"> is now <\/span><b><span data-contrast=\"auto\">reminderDateTime<\/span><\/b><span data-ccp-props=\"{&quot;201341983&quot;:0,&quot;335559739&quot;:160,&quot;335559740&quot;:259}\">\u00a0<\/span><\/li>\n<li data-leveltext=\"\uf0b7\" data-font=\"Symbol\" data-listid=\"1\" aria-setsize=\"-1\" data-aria-posinset=\"3\" data-aria-level=\"1\"><span data-contrast=\"auto\">The <\/span><b><span data-contrast=\"auto\">body<\/span><\/b><span data-contrast=\"auto\"> property name is now <\/span><b><span data-contrast=\"auto\">textBody<\/span><\/b><span data-contrast=\"auto\"> and its property type <\/span><b><span data-contrast=\"auto\">itemBody<\/span><\/b><span data-contrast=\"auto\"> is now String. In the future, we&#8217;ll also support <\/span><b><span data-contrast=\"auto\">htmlBody<\/span><\/b><span data-contrast=\"auto\"> on <\/span><b><span data-contrast=\"auto\">baseTask<\/span><\/b><span data-contrast=\"auto\"> resource<\/span><\/li>\n<\/ul>\n<p>For more information, see the <a href=\"https:\/\/docs.microsoft.com\/en-us\/graph\/api\/resources\/task?view=graph-rest-beta\">task resource type<\/a> documentation.<\/p>\n<h3>What do I need to do?<\/h3>\n<p><span data-contrast=\"auto\">Please update your code to rename references to reflect the renamed properties. After the breaking change, calls to this API using out-of-date property names will return nothing in response.<\/span><span data-ccp-props=\"{&quot;201341983&quot;:0,&quot;335559685&quot;:360,&quot;335559739&quot;:160,&quot;335559740&quot;:259}\">\u00a0<\/span><\/p>\n<p><span data-contrast=\"auto\">The changes will take effect on the Microsoft Graph beta endpoint on Feb 28<\/span><span data-contrast=\"auto\">th<\/span><span data-contrast=\"auto\">, 2022. Follow changes and updates on the <a href=\"https:\/\/devblogs.microsoft.com\/microsoft365dev\/category\/microsoft-graph\/\">Microsoft Graph developer blog<\/a>.<\/span><\/p>\n<p>Happy coding!<\/p>\n","protected":false},"excerpt":{"rendered":"<p>We\u2019re making a few necessary changes to property names and types, to align them with similar properties elsewhere in Microsoft Graph.<\/p>\n","protected":false},"author":69077,"featured_media":7754,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[3,11],"tags":[12,209],"class_list":["post-9605","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-microsoft-graph","category-office-add-ins","tag-outlook","tag-to-do-tasks"],"acf":[],"blog_post_summary":"<p>We\u2019re making a few necessary changes to property names and types, to align them with similar properties elsewhere in Microsoft Graph.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts\/9605","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=9605"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts\/9605\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/media\/7754"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/media?parent=9605"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/categories?post=9605"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/tags?post=9605"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}