nota: delta

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

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

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores 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 No admitida. No admitida.

Solicitud HTTP

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

Parámetros de consulta

El seguimiento de los cambios en las notas genera una ronda de una o varias llamadas de 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 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 toda la dirección URL de @odata.deltaLink , incluido este token, en la primera solicitud de la siguiente ronda de seguimiento de cambios para esa colección.
$skiptoken Cadena Token de estado devuelto en la dirección URL de @odata.nextLink de la llamada a la función delta anterior, lo que indica los cambios adicionales que se van a realizar.

Este método también admite los $selectparámetros de consulta , $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 la autenticación y la autorización.

Cuerpo de la solicitud

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

Respuesta

Si se ejecuta correctamente, este método devuelve un 200 OKcódigo de respuesta y una colección de objetos note en el cuerpo de la respuesta. La respuesta también incluye una dirección URL de @odata.nextLink o una dirección URL de @odata.deltaLink .

  • Si se devuelve una dirección URL de @odata.nextLink , quedan más páginas de datos por recuperar. La aplicación continúa realizando solicitudes mediante la dirección URL de @odata.nextLink hasta que se incluye una dirección URL de @odata.deltaLink en la respuesta.
  • Si se devuelve una dirección URL de @odata.deltaLink , no se devolverán más páginas de datos. Guarde la dirección URL de @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/beta/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/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
    }
  ]
}

Ejemplo 2: Solicitud diferencial posterior

En el ejemplo siguiente se muestra una solicitud de sincronización posterior mediante el token delta 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/beta/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/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