Hinweis: delta

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Ruft eine Gruppe von Notizobjekten ab, die seit der letzten Delta-Abfrage im Notizenordner des Benutzers hinzugefügt, aktualisiert oder gelöscht wurden. Ein Deltafunktionsaufruf für Notizen ähnelt einer GET-Anforderung, mit der Ausnahme, dass Sie durch entsprechendes Anwenden von Zustandstoken in einem oder mehreren dieser Aufrufe inkrementelle Änderungen in den Notizen abfragen können.

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 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 alle angegebenen Parameter automatisch in den Tokenteil der @odata.nextLink - oder @odata.deltaLink-URL , die in der Antwort angegeben wird.

Abfrageparameter Typ Beschreibung
$deltatoken Zeichenfolge Ein Zustandstoken, das in der @odata.deltaLink-URL des vorherigen Delta-Funktionsaufrufs 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 Zeichenfolge Ein Zustandstoken, das in der @odata.nextLink-URL des vorherigen Delta-Funktionsaufrufs zurückgegeben wird und auf weitere änderungen hinweist, die nachverfolgt werden sollen.

Diese Methode unterstützt auch die $selectOData-Abfrageparameter , $filter, $orderbyund $top zum Anpassen der Antwort.

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

Wenn die Methode erfolgreich verläuft, werden der 200 OK Antwortcode und eine Auflistung von Notizobjekten im Antworttext zurückgegeben. 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 mithilfe der url @odata.nextLink , 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 zum Abrufen aller Notizen.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

GET https://graph.microsoft.com/beta/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/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
    }
  ]
}

Beispiel 2: Nachfolgende Deltaanforderung

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

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

GET https://graph.microsoft.com/beta/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/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