todoTask: delta

  • Artículo

Espacio de nombres: microsoft.graph

Obtiene un conjunto de recursos todoTask que se han agregado, eliminado o actualizado en un todoTaskList especificado.

Una llamada de función delta para recursos todoTask en todoTaskList 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 todoTask en esa todoTaskList. Esto le permite mantener y sincronizar un almacén local de los recursos todoTask de un usuario sin tener que capturar todo el conjunto del servidor cada vez.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet
✅ ✅ ✅ ❌

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) Tasks.ReadWrite Tasks.Read
Delegado (cuenta personal de Microsoft) Tasks.ReadWrite Tasks.Read
Aplicación Tasks.ReadWrite.All Tasks.Read.All

Solicitud HTTP

GET /me/todo/lists/{id}/tasks/delta
GET /users/{id|userPrincipalName}/todo/lists/{todoTaskListId}/tasks/delta

Parámetros de consulta

El seguimiento de los cambios en una colección todoTask incurre en 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 cualquier parámetro especificado en la parte del token de la URL @odata.nextLink o @odata.deltaLink proporcionada en la respuesta. Solo debe especificar una vez por adelantado los parámetros de consulta deseados. En solicitudes posteriores, simplemente copie y aplique la @odata.nextLink dirección URL o @odata.deltaLink de la respuesta anterior, ya que esa dirección URL ya incluye los parámetros codificados y deseados.

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

Parámetros de consulta de OData

  • Puede utilizar un parámetro de consulta $select como en cualquier solicitud GET para especificar solo las propiedades que necesita para un mejor rendimiento. Siempre se devuelve la propiedad id.
  • Compatibilidad con $selectconsultas delta, $topy $expand para todoTask.
  • Hay compatibilidad limitada para $filter y $orderby:
    • Las únicas expresiones $filter admitidas son $filter=receivedDateTime+ge+{value} y $filter=receivedDateTime+gt+{value}.
    • La única expresión $orderby admitida es $orderby=receivedDateTime+desc. Si no incluye una expresión $orderby, no se garantiza el orden de devolución.
  • No hay compatibilidad con $search.

Encabezados de solicitud

Nombre Tipo Descripción
Authorization string {token} de portador. Obligatorio.
Content-Type string application/json. Necesario.
Prefer string odata.maxpagesize={x}. Opcional.

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta y un 200 OK objeto de colección todoTask en el cuerpo de la respuesta.

Ejemplo

Solicitud

Para realizar un seguimiento de los cambios en los recursos todoTask de todoTaskList desde la última ronda de seguimiento de cambios, realizaría una o varias llamadas a funciones delta para obtener el conjunto de cambios incrementales. En el ejemplo siguiente se muestra cómo comenzar una siguiente ronda de seguimiento de cambios, usando la dirección URL de la @odata.deltaLink devuelta desde la última llamada a función delta de la última ronda, que contiene .deltaToken Esta llamada de función delta limita el número máximo de todoTask en el cuerpo de la respuesta a 2.

GET https://graph.microsoft.com/v1.0/me/todo/lists/gDbc8U7HGwADDZocJgAAAA==/tasks/delta?$deltatoken=w0vf2jHg2mBXU-I2AK0FSWl0dopNtG8u5YoM

Respuesta

Si la solicitud es correcta, la respuesta debería incluir un símbolo de estado, que puede ser un skipToken
(en un encabezado de respuesta @odata.nextLink ) o deltaToken (en un encabezado de respuesta @odata.deltaLink ). Respectivamente, indican si debe continuar con la ronda o si ha completado la obtención de todos los cambios para esa ronda.

La respuesta siguiente muestra un skipToken en un encabezado de respuesta de @odata.nextLink.

Nota: el objeto de respuesta que se muestra aquí puede haberse acortado para mejorar la legibilidad.

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

{
   "@odata.deltaLink":"https://graph.microsoft.com/v1.0/me/todo/lists/gDbc8U7HGwADDZocJgAAAA==/tasks/delta?$deltatoken=MoVMZ_DzHG4AhT3WE8VioVS1IXZJ-ArqK5fknOjnKFY",
   "value":[
      {
         "@odata.etag":"W/\"4rfRVIPi9EqXgDbc8U7HGwADLLQ9xQ==\"",
         "importance":"normal",
         "isReminderOn":false,
         "status":"notStarted",
         "title":"empty task3",
         "createdDateTime":"2020-08-12T04:54:29.1925206Z",
         "lastModifiedDateTime":"2020-08-12T04:54:29.4903939Z",
         "id":"AAMkADMwNTcyZjQzLTdkMGItNDdjMy04ZTYwLTJhYmUzNGI5ZDEwMwBGAAAAAAB5M0K0qlJySLOAgV22zPnuBwDit9FUg_L0SpeANtzxTscbAAMNmhwmAADit9FUg_L0SpeANtzxTscbAAMxlnrYAAA=",
         "body":{
            "content":"",
            "contentType":"text"
         }
      }
   ]
}

Contenido relacionado