更新 outlooktask (已弃)
命名空间:microsoft.graph
重要
Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
注意
Outlook 任务 API 已弃用,将于 2022 年 8 月 20 日停止返回数据。 请使用新的微软待办 API。 有关详细信息,请参阅微软待办 API(公共预览版)。
更改任务任务的可Outlook属性。
completedDateTime 属性可通过完整操作设置,也可通过 PATCH 操作显式设置。 如果使用 PATCH 设置 completedDateTime, 请确保同时将 状态 设置为 completed 。
默认情况下,此操作 (POST、GET 和 complete 任务操作) UTC 格式返回与日期相关的属性。 你可以使用 Prefer: outlook.timezone 标头将响应中的所有与日期相关的属性都表示为与 UTC 不同的时区。
权限
要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限。
| 权限类型 | 权限(从最低特权到最高特权) |
|---|---|
| 委派(工作或学校帐户) | Tasks.ReadWrite |
| 委派(个人 Microsoft 帐户) | Tasks.ReadWrite |
| 应用程序 | 不支持。 |
HTTP 请求
PATCH /me/outlook/tasks/{id}
PATCH /users/{id|userPrincipalName}/outlook/tasks/{id}
请求标头
| 名称 | 说明 |
|---|---|
| Authorization | Bearer {token}。必需。 |
| Prefer: outlook.timezone | 指定响应中时间属性的时区,如果未指定此标头,则其时区为 UTC。 可选。 |
请求正文
在请求正文中,提供应更新的相关字段的值。请求正文中不包括的现有属性将保留其以前的值,或根据对其他属性值的更改重新计算。为了获得最佳性能,不应包括尚未更改的现有值。
| 属性 | 类型 | Description |
|---|---|---|
| body | itemBody | 通常包含有关任务的信息的任务正文。 请注意,仅支持 HTML 类型。 |
| 类别 | String 集合 | 与任务关联的类别。 |
| changeKey | String | 任务的版本。 |
| completedDateTime | dateTimeTimeZone | 在指定时区内完成任务的日期。 |
| createdDateTime | DateTimeOffset | 任务的创建日期和时间。 默认情况下,它采用 UTC 格式。 你可以在请求标头中提供自定义时区。 属性值使用 ISO 8601 格式。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。 |
| dueDateTime | dateTimeTimeZone | 要在指定时区内完成任务的日期。 |
| hasAttachments | Boolean | 如果任务包含附件,则设置为 true。 |
| importance | string | 事件的重要性。可能的值为: 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 | 提醒警报发出任务发生提醒的日期和时间。 |
| 敏感度 | string | 指示任务的隐私级别。 可取值为:normal、personal、private、confidential。 |
| startDateTime | dateTimeTimeZone | 要在指定时区内开始执行任务的日期。 |
| 状态 | string | 指示任务的状态或进度。 可取值为:notStarted、inProgress、completed、waitingOnOthers、deferred。 |
| 主题 | String | 任务的简要说明或标题。 |
响应
如果成功,此方法在响应正文中返回 响应代码和更新的 200 OK outlookTask 对象。
示例
请求
下面的示例修改 dueDateTime 属性,并使用 标头指定在东部标准时间 (EST 响应中表示与日期相关的 Prefer: outlook.timezone) 。
PATCH https://graph.microsoft.com/beta/me/outlook/tasks/AAMkADA1MTHgwAAA=
Prefer: outlook.timezone="Eastern Standard Time"
Content-type: application/json
{
"dueDateTime": {
"dateTime": "2016-05-06T16:00:00",
"timeZone": "Eastern Standard Time"
}
}
响应
这是一个示例响应。注意:为提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "AAMkADA1MTHgwAAA=",
"createdDateTime": "2016-04-22T18:19:18.9526004-04:00",
"lastModifiedDateTime": "2016-04-22T18:38:20.5541528-04:00",
"changeKey": "1/KC9Vmu40G3DwB6Lgs7MAAAIW9XXg==",
"categories": [
],
"assignedTo": null,
"body": {
"contentType": "text",
"content": ""
},
"completedDateTime": null,
"dueDateTime": {
"dateTime": "2016-05-06T00:00:00.0000000",
"timeZone": "Eastern Standard Time"
},
"hasAttachments":false,
"importance": "normal",
"isReminderOn": false,
"owner": "Administrator",
"parentFolderId": "AQMkADA1MTIBEgAAAA==",
"recurrence": null,
"reminderDateTime": null,
"sensitivity": "normal",
"startDateTime": {
"dateTime": "2016-05-03T00:00:00.0000000",
"timeZone": "Eastern Standard Time"
},
"status": "notStarted",
"subject": "Shop for children's weekend"
}
反馈
提交和查看相关反馈