注意：delta

命名空间：microsoft.graph

重要

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

获取自上次增量查询以来在用户的 Notes 文件夹中添加、更新或删除的一组笔记对象。 注释的 delta 函数调用类似于 GET 请求，不同之处在于，通过在一个或多个调用中适当应用 状态令牌 ，可以在笔记中查询增量更改。

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型 最低特权权限 更高特权权限
委派（工作或学校帐户） ShortNotes.Read ShortNotes.ReadWrite
委派（个人 Microsoft 帐户） ShortNotes.Read ShortNotes.ReadWrite
应用程序 不支持。 不支持。

HTTP 请求

GET /me/notes/delta
GET /users/{id | userPrincipalName}/notes/delta

查询参数

跟踪笔记中的更改会导致一轮或多次 增量 函数调用。 如果要使用任意查询参数（$deltatoken 和 $skiptoken 除外），则必须在最初的 delta 请求中指定它。 Microsoft Graph 自动将任何指定的参数编码为响应中提供的 @odata.nextLink 或 @odata.deltaLink URL 的标记部分。

查询参数 类型 说明
$deltatoken String 在上一个 delta 函数调用的 @odata.deltaLink URL 中返回的状态令牌，指示完成这一轮更改跟踪。 在该集合的下一轮更改跟踪的第一个请求中保存并应用整个 @odata.deltaLink URL，包括此令牌。
$skiptoken String 在上一个 delta 函数调用的 @odata.nextLink URL 中返回的状态令牌，指示要跟踪的进一步更改。

此方法还支持 $select、 $filter、 $orderby和 $top OData 查询参数，以帮助自定义响应。

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。

请求正文

请勿提供此方法的请求正文。

响应

如果成功，此方法在响应正文中返回响应 200 OK 代码和 注释 对象的集合。 响应还包括 @odata.nextLink URL 或 @odata.deltaLink URL。

  • 如果返回 @odata.nextLink URL，则仍要检索更多数据页。 应用程序继续使用 @odata.nextLink URL 发出请求，直到响应中包含 @odata.deltaLink URL。
  • 如果返回 @odata.deltaLink URL，则不会再返回更多的数据页。 保存 @odata.deltaLink URL，以便在下一次 增量 调用中使用。

示例

示例 1：初始同步请求

以下示例演示用于获取所有笔记的初始同步请求。

请求

以下示例显示了一个请求。

GET https://graph.microsoft.com/beta/me/notes/delta

响应

以下示例显示了相应的响应。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('user-id')/notes",
  "@odata.deltaLink": "https://graph.microsoft.com/beta/me/notes/delta?$deltatoken=abc123def456",
  "value": [
    {
      "id": "AAMkAGI2THVSAAA=",
      "changeKey": "CQAAABYAAABE",
      "createdDateTime": "2024-01-15T10:00:00Z",
      "lastModifiedDateTime": "2024-01-20T11:00:00Z",
      "categories": [],
      "subject": "Updated Note",
      "body": {
        "contentType": "html",
        "content": "<html><body>Updated content</body></html>"
      },
      "bodyPreview": "Updated content",
      "isDeleted": false,
      "hasAttachments": false
    }
  ]
}

示例 2：后续增量请求

以下示例演示了使用上一响应中的增量令牌的后续同步请求。 将返回新的、更新的和已删除的笔记。

请求

以下示例显示了一个请求。

GET https://graph.microsoft.com/beta/me/notes/delta?$deltatoken=abc123def456

响应

以下示例显示了相应的响应。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('user-id')/notes",
  "@odata.deltaLink": "https://graph.microsoft.com/beta/me/notes/delta?$deltatoken=xyz789new",
  "value": [
    {
      "id": "AAMkAGI2NEWITEM=",
      "changeKey": "CQAAABYAAABF",
      "subject": "New Note",
      "bodyPreview": "New content",
      "createdDateTime": "2024-01-21T08:00:00Z",
      "lastModifiedDateTime": "2024-01-21T08:00:00Z"
    },
    {
      "@removed": {
        "reason": "deleted"
      },
      "id": "AAMkAGI2DELETED="
    }
  ]
}
  • Last updated on