todoTaskList: delta

Espacio de nombres: microsoft.graph

Obtenga un conjunto de recursos todoTaskList que se han agregado, eliminado o quitado en Microsoft To Do.

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

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

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.

Solicitud HTTP

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

Parámetros de consulta

El seguimiento de los cambios en los recursos todoTaskList 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 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á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.

Encabezados de solicitud

Respuesta

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

Ejemplo

Solicitud

En el ejemplo siguiente se muestra cómo realizar una llamada de función delta inicial y limitar el número máximo de todoTaskList en el cuerpo de la respuesta a 2.

Para realizar un seguimiento de los cambios en todoTaskList, realizaría una o varias llamadas a funciones delta , con tokens de estado adecuados, para obtener el conjunto de cambios incrementales desde la última consulta delta.

Las principales diferencias entre el seguimiento de todoTaskList y el seguimiento de los recursos todoTask de una lista se encuentran en las direcciones URL de solicitud de consulta delta y las respuestas de consulta que devuelven todoTaskList en lugar de colecciones todoTask .

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

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Todo.Lists.Delta.GetAsDeltaGetResponseAsync();

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
delta, err := graphClient.Me().Todo().Lists().Delta().GetAsDeltaGetResponse(context.Background(), nil)

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.me().todo().lists().delta().get();

const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/me/todo/lists/delta')
	.get();

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->me()->todo()->lists()->delta()->get()->wait();

Import-Module Microsoft.Graph.Users

# A UPN can also be used as -UserId.
Get-MgUserTodoListDelta -UserId $userId

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.me.todo.lists.delta.get()

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/delta?$skiptoken=ldfdgdgfoT5csv4k99nvQqyku0jaGqMhc6XyFff5qQTQ7RJOr",
  "value": [
    {
      "@odata.etag":"W/\"4rfRVIPi9EqXgDbc8U7HGwADLLQ93w==\"",
         "displayName":"List1",
         "isOwner":true,
         "isShared":false,
         "wellknownListName":"none",
         "id":"AQMkADMwNTcyZjQzLTdkMGItNDdjMy04ZTYwLTJhYmUzNGI5ZD"
    }
  ]
}

Contenido relacionado

• Consulta delta de Microsoft Graph