Nota: Delta

Espacio de nombres: microsoft.graph

Obtenga un conjunto de objetos de nota que se agregaron, actualizaron o eliminaron en la carpeta Notas del usuario desde la última consulta delta. Una llamada de función delta para notas es similar a una solicitud GET, excepto que mediante la aplicación adecuada de tokens de estado en una o varias de estas llamadas, puede consultar cambios incrementales en las notas.

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) ShortNotes.Read ShortNotes.ReadWrite
Delegado (cuenta personal de Microsoft) ShortNotes.Read ShortNotes.ReadWrite
Aplicación ShortNotes.Read.All ShortNotes.ReadWrite.All

Solicitud HTTP

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

Parámetros de consulta

El seguimiento de los cambios en notas incurre en una ronda de una o más llamadas a la función delta . Si usa cualquier parámetro de consulta (distinto de $deltatoken y $skiptoken), debe especificarlo en la solicitud delta inicial. Microsoft Graph codifica automáticamente los parámetros especificados en la parte del token de la dirección URL @odata.nextLink o @odata.deltaLink proporcionada en la respuesta.

Parámetro de consulta Tipo Descripción
$deltatoken Cadena Un token de estado devuelto en la dirección URL @odata.deltaLink de la llamada a la función delta anterior, que indica la finalización de esa ronda de seguimiento de cambios. Guarde y aplique la dirección URL completa de @odata.deltaLink , incluido este token, en la primera solicitud de la siguiente ronda de seguimiento de cambios para esa colección.
$skiptoken Cadena Un token de estado devuelto en la dirección URL @odata.nextLink de la llamada de función delta anterior, lo que indica que se deben realizar más cambios.

Este método también admite los parámetros de $selectconsulta , $filter, $orderbyy $top OData para ayudar a personalizar la respuesta.

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre autenticación y autorización.

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Si tiene éxito, este método devuelve un 200 OK código de respuesta y una colección de objetos de nota en el cuerpo de la respuesta. La respuesta también incluye una dirección URL @odata.nextLink o una dirección URL @odata.deltaLink .

  • Si se devuelve una dirección URL @odata.nextLink , quedan más páginas de datos por recuperar. La aplicación continúa realizando solicitudes mediante la dirección URL @odata.nextLink hasta que se incluya una dirección URL @odata.deltaLink en la respuesta.
  • Si se devuelve una dirección URL @odata.deltaLink , no quedan más páginas de datos por devolver. Guarde la dirección URL @odata.deltaLink para usarla en la siguiente llamada delta .

Ejemplos

Ejemplo 1: Solicitud de sincronización inicial

En el ejemplo siguiente se muestra la solicitud de sincronización inicial para obtener todas las notas.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

GET https://graph.microsoft.com/v1.0/me/notes/delta

Respuesta

En el ejemplo siguiente se muestra la respuesta.

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

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('user-id')/notes",
  "@odata.deltaLink": "https://graph.microsoft.com/v1.0/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
    }
  ]
}

Ejemplo 2: Solicitud delta posterior

En el ejemplo siguiente se muestra una solicitud de sincronización posterior con el token diferencial de la respuesta anterior. Se devuelven notas nuevas, actualizadas y eliminadas.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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

Respuesta

En el ejemplo siguiente se muestra la respuesta.

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

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('user-id')/notes",
  "@odata.deltaLink": "https://graph.microsoft.com/v1.0/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