命名空间：microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
警告
Outlook 任务 API 已于 2022 年 8 月 20 日弃用并停止返回数据。 请改用 “To Do API ”。
可用于跟踪工作项目的 Outlook 项目。
可以使用任务来跟踪：
- 开始、截止日期和实际完成日期和时间。
- 任务的进度或状态。
- 任务的重复周期和提醒状态。
outlookTask 资源中与日期相关的属性包括：
- completedDateTime
- createdDateTime
- dueDateTime
- lastModifiedDateTime
- reminderDateTime
- startDateTime
默认情况下，POST、GET、PATCH 和完成操作会在 UTC 的 REST 响应中返回与日期相关的属性。
你可以使用 Prefer: outlook.timezone 标头将响应中的所有与日期相关的属性都表示为与 UTC 不同的时区。 以下示例在对应响应的 EST 中返回与日期相关的属性：
Prefer: outlook.timezone="Eastern Standard Time"
方法
| 方法 | 返回类型 | 说明 |
|---|---|---|
| Get | outlookTask | 获取用户邮箱中的 Outlook 任务的属性和关系。 |
| 更新 | outlookTask | 更改 Outlook 任务的可写属性。 |
| 删除 | 无 | 删除用户邮箱中的指定任务。 |
| 永久删除 | 无 | 永久删除 Outlook 任务，并将其放置在用户邮箱的“可恢复邮件”文件夹中的“清除”文件夹中。 |
| 完成 | outlookTask 集合 | 完成 Outlook 任务，该任务将 completedDateTime 属性设置为当前日期，将 status 属性设置为 completed。 |
| 附件 | ||
| 列出附件 | attachment 集合 | 获取 Outlook 任务的所有附件。 |
| 添加附件 | 附件 | 向任务添加作为附件的文件、项目（消息、事件或联系人）或文件链接。 |
| 扩展属性 | ||
| 创建单值属性 | outlookTask | 在新建或现有 Outlook 任务中创建一个或多个单值扩展属性。 |
| 获取单值属性 | outlookTask | 通过使用 $expand 或 $filter 获取包含单值扩展属性的 Outlook 任务。 |
| 创建多值属性 | outlookTask | 在新建或现有的 Outlook 任务中创建一个或多个多值扩展属性。 |
| 获取多值属性 | outlookTask | 使用 $expand 获取包含一个多值扩展属性的 Outlook 任务。 |
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| assignedTo | String | Outlook 中已为其分配任务的人员姓名。 只读。 |
| 正文 | itemBody | 通常包含有关任务的信息的任务正文。 仅支持 HTML 类型。 |
| 类别 | String 集合 | 与任务关联的类别。 每个类别对应于用户定义的 outlookCategory 的 displayName 属性。 |
| changeKey | String | 任务的版本。 |
| completedDateTime | dateTimeTimeZone | 在指定时区内完成任务的日期。 |
| createdDateTime | DateTimeOffset | 任务的创建日期和时间。 默认情况下，它采用 UTC 格式。 你可以在请求标头中提供自定义时区。 属性值使用 ISO 8601 格式。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。 |
| dueDateTime | dateTimeTimeZone | 要在指定时区内完成任务的日期。 |
| hasAttachments | Boolean | 如果任务包含附件，则设置为 true。 |
| id | String | 任务的唯一标识符。
默认情况下，当项从一个容器（如文件夹或日历）移动到另一个容器时，此值会更改。 若要更改此行为，请使用 Prefer: IdType="ImmutableId"头。 有关详细信息，请参阅获取 Outlook 资源的不可变标识符。 只读。 |
| importance | importance | 事件的重要性。 可能的值包括 low、normal、high。 |
| isReminderOn | Boolean | 如果设置警报以提醒用户有任务，则设置为 true。 |
| lastModifiedDateTime | DateTimeOffset | 上次修改任务的日期和时间。 默认情况下，它采用 UTC 格式。 你可以在请求标头中提供自定义时区。 属性值使用 ISO 8601 格式，并始终处于 UTC 时间。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。 |
| Owner | String | 任务创建者的姓名。 |
| parentFolderId | String | 任务的父文件夹的唯一标识符。 |
| 定期 | patternedRecurrence | 任务的定期模式。 |
| reminderDateTime | dateTimeTimeZone | 提醒警报发出任务发生提醒的日期和时间。 |
| 敏感度 | 敏感度 | 指示任务的隐私级别。 可能的值包括 normal、personal、private、confidential。 |
| startDateTime | dateTimeTimeZone | 要在指定时区内开始执行任务的日期。 |
| 状态 | 任务状态 | 指示任务的状态或进度。 可能的值包括 notStarted、inProgress、completed、waitingOnOthers、deferred。 |
| subject | String | 任务的简要说明或标题。 |
关系
| 关系 | 类型 | 说明 |
|---|---|---|
| attachments | attachment 集合 | 任务的 fileAttachment、itemAttachment 和 referenceAttachment 附件的集合。 只读。 可为 Null。 |
| multiValueExtendedProperties | multiValueLegacyExtendedProperty 集合 | 为任务定义的多值扩展属性的集合。 只读。 可为 Null。 |
| singleValueExtendedProperties | singleValueLegacyExtendedProperty 集合 | 为任务定义的单值扩展属性的集合。 只读。 可为 Null。 |
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"assignedTo": "String",
"body": {"@odata.type": "microsoft.graph.itemBody"},
"categories": ["String"],
"changeKey": "String",
"completedDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"createdDateTime": "String (timestamp)",
"dueDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"hasAttachments": true,
"id": "String (identifier)",
"importance": "string",
"isReminderOn": true,
"lastModifiedDateTime": "String (timestamp)",
"owner": "String",
"parentFolderId": "String",
"recurrence": {"@odata.type": "microsoft.graph.patternedRecurrence"},
"reminderDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"sensitivity": "string",
"startDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"status": "string",
"subject": "String"
}