使用微软待办 API

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

使用在 todoTask 上构建的 Microsoft Graph 待办事项 API 创建一个可跨 Microsoft To Do 客户端任务连接的应用。 使用任务构建各种体验,如下所示:

  • 从应用的工作流(例如,从电子邮件或通知)创建任务,并将其保存到微软待办中。 使用 linkedResource 实体将链接存储回你的应用。
  • 将应用的现有任务与微软待办进行同步,并创建单个任务视图,以便更好地确定优先顺序和实施管理。
  • 在自定义业务应用程序中管理微软待办任务。

API 支持委托权限和应用程序权限。

在开始使用微软待办 API 之前,请查看资源以及它们之间的关系。

突出显示待办事项 API 实体的屏幕截图。屏幕截图显示了左侧的任务列表、中心内特定任务列表中的任务,以及右侧的清单项和链接资源以及其他任务属性。

任务列表

在此 API 集中,任务列表由 todoTaskList 表示,它是 todoTask 资源的逻辑容器。 目前只能在任务列表中创建任务。 若要获取所有任务列表,请执行以下 HTTP 请求:

GET /me/todo/lists

任务

在此 API 集中,任务由 todoTask 资源表示,该资源是可跟踪和完成的工作项或个人项目。 若要从任务列表中获取任务,请执行以下 HTTP 请求:

GET /me/todo/lists/{todoTaskListId}/tasks

清单项

checklistItem 表示较大的 todoTask 中的子任务。 通过 ChecklistItem,可将复杂任务分解为更具可操作性、更小的任务。 若要从任务获取 checklistItem,请发出以下 HTTP 请求:

GET /me/todo/lists/{todoTaskListId}/tasks/{todoTaskId}/checklistItems/{checklistItems}

链接的资源

linkedResource 表示与任务相关的合作伙伴应用程序中的任何项目,例如从中创建任务的项目(如电子邮件)。 可以使用它来将信息和链接存储回你的应用中的相关项。 若要从任务获取链接的资源,请执行以下 HTTP 请求:

GET /me/todo/lists/{todoTaskListId}/tasks/{todoTaskId}/linkedresources/{linkedResourceId}

使用 delta 查询跟踪更改

出于性能原因,可能需要维护对象的本地缓存,并使用 delta 查询定期将本地缓存与服务器同步。

以下微软待办 API 资源支持 delta 查询: