Hinweis: Delta

Namespace: microsoft.graph

Rufen Sie eine Reihe von Notizobjekten ab, die seit der letzten Deltaabfrage im Notizenordner des Benutzers hinzugefügt, aktualisiert oder gelöscht wurden. Ein Delta-Funktionsaufruf für Notizen ähnelt einer GET-Anforderung, mit dem Unterschied, dass Sie durch entsprechende Anwendung von Zustandstoken in einem oder mehreren dieser Aufrufe inkrementelle Änderungen in den Notizen abfragen können.

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

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. 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) ShortNotes.Read ShortNotes.ReadWrite
Delegiert (persönliches Microsoft-Konto) ShortNotes.Read ShortNotes.ReadWrite
Application Nicht unterstützt Nicht unterstützt

HTTP-Anforderung

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

Abfrageparameter

Das Nachverfolgen von Änderungen in Notizen führt zu einer Runde von einem oder mehreren Delta-Funktionsaufrufen. 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 @odata.nextLink - oder @odata.deltaLink-URL , die in der Antwort angegeben ist.

Abfrageparameter Typ Beschreibung
$deltatoken Zeichenfolge Ein Zustandstoken, das in der @odata.deltaLink-URL des vorherigen Delta-Funktionsaufrufs zurückgegeben wurde und den Abschluss dieser Runde der Änderungsnachverfolgung angibt. Speichern Sie die gesamte @odata.deltaLink-URL , einschließlich dieses Tokens, und wenden Sie sie in der ersten Anforderung der nächsten Runde der Änderungsnachverfolgung für diese Sammlung an.
$skiptoken Zeichenfolge Ein Zustandstoken, das in der @odata.nextLink-URL des vorherigen Delta-Funktionsaufrufs zurückgegeben wurde und weitere zu verfolgende Änderungen angibt.

Diese Methode unterstützt auch die $selectOData-Abfrageparameter , $filter$orderby, und $top OData, um die Antwort anzupassen.

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.

Anforderungstext

Geben Sie keinen Anforderungstext für diese Methode an.

Antwort

Bei erfolgreicher Ausführung gibt diese Methode einen 200 OK Antwortcode und eine Auflistung von Notizobjekten im Antworttext zurück. Die Antwort enthält auch eine @odata.nextLink-URL oder eine @odata.deltaLink-URL .

  • Wenn eine @odata.nextLink-URL zurückgegeben wird, müssen noch weitere Seiten mit Daten abgerufen werden. Die Anwendung stellt weiterhin Anforderungen unter Verwendung der @odata.nextLink-URL , bis eine @odata.deltaLink-URL in der Antwort enthalten ist.
  • Wenn eine @odata.deltaLink-URL zurückgegeben wird, müssen keine weiteren Seiten mit Daten zurückgegeben werden. Speichern Sie die @odata.deltaLink-URL für die Verwendung im nächsten Delta-Aufruf .

Beispiele

Beispiel 1: Anfängliche Synchronisierungsanforderung

Das folgende Beispiel zeigt die anfängliche Synchronisierungsanforderung, um alle Notizen abzurufen.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

Antwort

Das folgende Beispiel zeigt die Antwort.

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

Beispiel 2: Nachfolgende Deltaanforderung

Das folgende Beispiel zeigt eine nachfolgende Synchronisierungsanforderung mit dem Deltatoken aus der vorherigen Antwort. Neue, aktualisierte und gelöschte Notizen werden zurückgegeben.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

Antwort

Das folgende Beispiel zeigt die Antwort.

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