Freigeben über


todoTaskList: delta

Namespace: microsoft.graph

Rufen Sie eine Reihe von todoTaskList-Ressourcen ab, die in Microsoft To Do hinzugefügt, gelöscht oder entfernt wurden.

Ein Delta-Funktionsaufruf für todoTaskList ähnelt einer GET-Anforderung, mit der Ausnahme, dass Sie durch entsprechendes Anwenden von Zustandstoken in einem oder mehreren dieser Aufrufe inkrementelle Änderungen in todoTaskList abfragen können. Auf diese Weise können Sie einen lokalen Speicher der todoTaskList eines Benutzers verwalten und synchronisieren, ohne jedes Mal die gesamte todoTaskList vom Server abrufen zu müssen.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Globaler Dienst US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) Tasks.ReadWrite Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Tasks.ReadWrite Nicht verfügbar.
Anwendung Tasks.Read.All Tasks.ReadWrite.All

HTTP-Anforderung

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

Abfrageparameter

Das Nachverfolgen von Änderungen in todoTaskList-Ressourcen verursacht eine Runde von einem oder mehreren Deltafunktionsaufrufen. Wenn Sie Abfrageparameter (außer $deltatoken und $skiptoken) verwenden, müssen Sie sie in der ursprünglichen Delta-Anforderung angeben. Microsoft Graph codiert automatisch alle angegebenen Parameter in den Tokenteil der in der Antwort enthaltenen @odata.nextLink- oder @odata.deltaLink-URL. Sie müssen alle gewünschten Abfrageparameter nur einmal im Vorfeld angeben. Kopieren Sie in nachfolgenden Anforderungen einfach die - oder @odata.deltaLink -@odata.nextLinkURL aus der vorherigen Antwort, und wenden Sie sie an, da diese URL bereits die codierten gewünschten Parameter enthält.

Abfrageparameter Typ Beschreibung
$deltatoken string Ein Zustandstoken, das in der @odata.deltaLink URL des vorherigen Delta-Funktionsaufrufs für dieselbe todoTaskList-Auflistung zurückgegeben wird und den Abschluss dieser Änderungsnachverfolgung angibt. Speichern Sie die gesamte @odata.deltaLink-URL einschließlich dieses Tokens, und wenden Sie sie in der ersten Anforderung der nächsten Änderungsnachverfolgungsrunde für diese Sammlung an.
$skiptoken string Ein Zustandstoken, das in der @odata.nextLink URL des vorherigen Delta-Funktionsaufrufs zurückgegeben wird und angibt, dass weitere Änderungen in derselben todoTaskList-Auflistung nachverfolgt werden müssen.

OData-Abfrageparameter

Sie können wie bei jeder GET-Anforderung den Abfrageparameter $select verwenden, um zwecks Leistungsoptimierung nur die benötigten Eigenschaften anzugeben. Die Eigenschaft id wird immer zurückgegeben.

Anforderungsheader

Name Typ Beschreibung
Authorization string Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung.
Content-Type string application/json. Erforderlich.
Prefer string odata.maxpagesize={x}. Optional.

Antwort

Wenn die Methode erfolgreich verläuft, werden der 200 OK Antwortcode und das TodoTaskList-Auflistungsobjekt im Antworttext zurückgegeben.

Beispiel

Anforderung

Das folgende Beispiel zeigt, wie Sie einen anfänglichen Delta-Funktionsaufruf durchführen und die maximale Anzahl von todoTaskList im Antworttext auf 2 begrenzen.

Um Änderungen in todoTaskList nachzuverfolgen, würden Sie einen oder mehrere Deltafunktionsaufrufe mit entsprechenden Zustandstoken ausführen, um den Satz inkrementeller Änderungen seit der letzten Deltaabfrage abzurufen.

Die Hauptunterschiede zwischen der Nachverfolgung von todoTaskList-Ressourcen und der Nachverfolgung von todoTask-Ressourcen in einer Liste bestehen in den Delta-Abfrageanforderungs-URLs und den Abfrageantworten, die todoTaskList anstelle von todoTask-Auflistungen zurückgeben.

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

Antwort

Wenn die Anforderung erfolgreich ist, enthält die Antwort ein Statustoken, entweder ein skipToken
(in einem @odata.nextLink-Antwortheader ) oder einem deltaToken (in einem @odata.deltaLink-Antwortheader ). Sie geben jeweils an, ob Sie mit der Runde fortfahren sollten oder ob Sie alle Änderungen für diese Runde abgeschlossen haben.

Die Antwort unten zeigt ein skipToken in einem @odata.nextLink-Antwortheader.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt sein.

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"
    }
  ]
}