命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
更新 note 对象的属性。 支持通过 If-Match 具有 note 的 changeKey 值的标头进行乐观并发控制。
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
| 权限类型 | 最低特权权限 | 更高特权权限 |
|---|---|---|
| 委派(工作或学校帐户) | ShortNotes.ReadWrite | 不可用。 |
| 委派(个人 Microsoft 帐户) | ShortNotes.ReadWrite | 不可用。 |
| 应用程序 | 不支持。 | 不支持。 |
HTTP 请求
PATCH /me/notes/{note-id}
PATCH /users/{id | userPrincipalName}/notes/{note-id}
请求标头
| 名称 | 说明 |
|---|---|
| Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
| Content-Type | application/json. 必需。 |
| If-Match | 注释的 changeKey 值用于乐观并发控制。 可选。 建议使用此标头以避免冲突。 |
请求正文
在请求正文中, 仅 提供要更新的属性的值。 请求正文中未包含的现有属性会保留其以前的值,或者根据对其他属性值的更改重新计算。
下表指定可更新的属性。
| 属性 | 类型 | 说明 |
|---|---|---|
| body | itemBody | 注释的内容。 支持 text 或 html 内容类型。 可选。 |
| 类别 | String collection | 与注释关联的类别。 可选。 |
| subject | String | 注释的标题。 可选。 |
响应
如果成功,此方法在响应正文中返回响应 200 OK 代码和更新的 note 对象。
If-Match如果标头与当前 changeKey 不匹配,此方法将412 Precondition Failed返回响应代码。
示例
请求
以下示例显示了一个请求。
PATCH https://graph.microsoft.com/beta/me/notes/AAMkAGI2THVSAAA=
Content-Type: application/json
If-Match: "CQAAABYAAABE"
{
"subject": "Updated Meeting Notes - Jan 28",
"body": {
"contentType": "html",
"content": "<html><body><h2>Updated Standup</h2><ul><li>Task 1 completed</li><li>Task 2 in progress</li></ul></body></html>"
}
}
响应
以下示例显示了相应的响应。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#users('user-id')/notes/$entity",
"id": "AAMkAGI2THVSAAA=",
"changeKey": "CQAAABYAAABG",
"createdDateTime": "2024-01-15T10:30:00Z",
"lastModifiedDateTime": "2024-01-28T09:45:00Z",
"categories": [],
"subject": "Updated Meeting Notes - Jan 28",
"body": {
"contentType": "html",
"content": "<html><body><h2>Updated Standup</h2><ul><li>Task 1 completed</li><li>Task 2 in progress</li></ul></body></html>"
},
"bodyPreview": "Updated Standup Task 1 completed Task 2 in progress",
"isDeleted": false,
"hasAttachments": false
}