orgContact: 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.
Rufen Sie neu erstellte, aktualisierte oder gelöschte Organisationskontakte ab, ohne die gesamte Sammlung vollständig lesen zu müssen. Weitere Informationen finden Sie unter Verwenden von Deltaabfragen zum Nachverfolgen von Änderungen in Microsoft Graph-Daten .
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) | OrgContact.Read.All | Directory.Read.All, Directory.ReadWrite.All |
Delegiert (persönliches Microsoft-Konto) | Nicht unterstützt | Nicht unterstützt |
Anwendung | OrgContact.Read.All | Directory.Read.All, Directory.ReadWrite.All |
Wichtig
In delegierten Szenarien mit Geschäfts-, Schul- oder Unikonten muss dem angemeldeten Benutzer eine unterstützte Microsoft Entra Rolle oder eine benutzerdefinierte Rolle mit einer unterstützten Rollenberechtigung zugewiesen werden. Die folgenden Rollen mit den geringsten Berechtigungen werden für diesen Vorgang unterstützt.
- Verzeichnisleseberechtigte – Grundlegende Eigenschaften lesen
- Globaler Leser
- Verzeichnisautoren
- Intune Administrator
- Benutzeradministrator
HTTP-Anforderung
Um mit der Nachverfolgung von Änderungen zu beginnen, stellen Sie eine Anforderung, indem Sie die Delta-Funktion in die Ressource contacts einschließen.
GET /contacts/delta
Abfrageparameter
Das Nachverfolgen von Änderungen in Organisationskontakten 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 Abfrageparameter nur einmal im Voraus angeben.
Kopieren Sie in nachfolgenden Anforderungen die URL oder @odata.deltaLink
aus der @odata.nextLink
vorherigen Antwort, und wenden Sie sie an. Diese URL enthält bereits die codierten Parameter.
Abfrageparameter | Typ | Beschreibung |
---|---|---|
$deltatoken | string | Ein Zustandstoken, das in der @odata.deltaLink URL des vorherigen Delta-Funktionsaufrufs für dieselbe organization Kontaktsammlung zurückgegeben wird und den Abschluss dieser Runde der Änderungsnachverfolgung angibt. Speichern Und anwenden Sie die gesamte @odata.deltaLink URL einschließlich dieses Tokens in der ersten Anforderung der nächsten Änderungsnachverfolgungsrunde für diese Sammlung. |
$skiptoken | string | Ein Zustandstoken, das in der @odata.nextLink URL des vorherigen Delta-Funktionsaufrufs zurückgegeben wird und angibt, dass weitere Änderungen in derselben organization Kontaktsammlung nachverfolgt werden müssen. |
OData-Abfrageparameter
Diese Methode unterstützt optionale OData-Abfrageparameter, um die Antwort anzupassen.
- Sie können einen
$select
Abfrageparameter wie in jeder GET-Anforderung verwenden, um nur die Eigenschaften anzugeben, die Sie für eine optimale Leistung benötigen. Die Eigenschaft id wird immer zurückgegeben. - Es gibt eingeschränkte Unterstützung für
$filter
:- Der einzige unterstützte
$filter
-Ausdruck dient zum Nachverfolgen von Änderungen an einem bestimmten Objekt:$filter=id+eq+{value}
. Sie können mehrere Objekte filtern. Beispiel:https://graph.microsoft.com/beta/contacts/delta/?$filter= id eq '477e9fc6-5de7-4406-bb2a-7e5c83c9ffff' or id eq '004d6a07-fe70-4b92-add5-e6e37b8affff'
. Es gibt einen Grenzwert von 50 gefilterten Objekten.
- Der einzige unterstützte
Anforderungsheader
Name | Beschreibung |
---|---|
Authorization | Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung. |
Prefer | return=minimal Wenn Sie für diese Kopfzeile eine Aufforderung festlegen, die ein @odata.deltaLink verwendet, würden nur die Objekteigenschaften zurückgegeben werden, die seit der letzten Runde geändert wurden. Optional. |
Anforderungstext
Geben Sie keinen Anforderungstext für diese Methode an.
Antwort
Bei erfolgreicher Ausführung gibt die Methode den 200 OK
Antwortcode und ein orgContact-Auflistungsobjekt 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:- Dies bedeutet, es gibt zusätzliche Seiten mit Daten, die in der Sitzung abgerufen werden müssen. Die Anwendung nimmt weiterhin Anforderungen über die
@odata.nextLink
-URL vor, bis eine@odata.deltaLink
-URL in der Antwort zurückgegeben wird. - Die Antwort enthält die gleiche Gruppe von Eigenschaften, wie in der ersten Anforderung einer Delta-Abfrage. Dadurch können Sie den vollständigen aktuellen Status der Objekte beim Initiieren des Delta-Zyklus erfassen.
- Dies bedeutet, es gibt zusätzliche Seiten mit Daten, die in der Sitzung abgerufen werden müssen. Die Anwendung nimmt weiterhin Anforderungen über die
Wenn eine
@odata.deltaLink
-URL zurückgegeben wird:- Dies weist darauf hin, dass keine Weiteren Daten zum vorhandenen Zustand der ressource vorhanden sind, die zurückgegeben werden soll. Speichern Sie und verwenden Sie die
@odata.deltaLink
-URL, um Informationen über die Änderungen an der Ressource in der nächsten Runde zu erhalten. - Sie können die
Prefer:return=minimal
-Kopfzeile so festlegen, dass in der Antwort nur die Eigenschaften Werte enthalten sind, die seit dem Zeitpunkt geändert wurden, an dem die@odata.deltaLink
erstellt wurde.
- Dies weist darauf hin, dass keine Weiteren Daten zum vorhandenen Zustand der ressource vorhanden sind, die zurückgegeben werden soll. Speichern Sie und verwenden Sie die
Standard: Es werden dieselben Eigenschaften zurückgegeben wie die der ursprünglichen Delta-Anfrage
Standardmäßig geben Abfragen, die @odata.deltaLink
oder @odata.nextLink
verwenden, dieselben Eigenschaften zurück, wie sie in der ersten Delta-Abfrage ausgewählt wurden. Diese geschieht wie folgt:
- Wenn die Eigenschaft geändert wurde, ist der neue Wert in der Antwort enthalten. Dies schließt Eigenschaften ein, die auf einen Null-Wert festgelegt werden.
- Wenn sich die Eigenschaft nicht geändert hat, wird der alte Wert in die Antwort aufgenommen.
- Wenn die Eigenschaft noch nie festgelegt wurde, wird sie überhaupt nicht in die Antwort eingeschlossen.
Anmerkung: Bei diesem Verhalten ist es nicht möglich, anhand der Antwort zu erkennen, ob sich eine Eigenschaft ändert. Außerdem sind die Deltaantworten in der Regel groß, da sie alle Eigenschaftswerte enthalten (siehe Beispiel 2).
Alternative: nur die geänderten Eigenschaften zurückgeben
Das Hinzufügen eines optionalen Anfrage-Headers – prefer:return=minimal
– führt zu folgendem Verhalten:
- Wenn die Eigenschaft geändert wurde, ist der neue Wert in der Antwort enthalten. Dies schließt Eigenschaften ein, die auf einen Null-Wert festgelegt werden.
- Wenn die Eigenschaft nicht geändert wurde, ist die Eigenschaft überhaupt nicht in der Antwort enthalten. (Anders als beim Standardverhalten).
Hinweis: Die Kopfzeile kann zu jedem Zeitpunkt im Delta-Zyklus zu einer
@odata.deltaLink
-Abfrage hinzugefügt werden. Der Header wirkt sich nur auf den Satz von Eigenschaften aus, die in der Antwort enthalten sind, und er wirkt sich nicht darauf aus, wie die Deltaabfrage ausgeführt wird. Siehe Beispiel 3.
Beispiele
Beispiel 1: Standardeigenschaften
Anforderung
Das folgende Beispiel zeigt eine Anfrage. Da kein $select
Parameter vorhanden ist, wird ein Standardsatz von Eigenschaften nachverfolgt und zurückgegeben.
GET https://graph.microsoft.com/beta/contacts/delta
Antwort
Hier sehen Sie ein Beispiel für die Antwort, wenn sie aus @odata.deltaLink
der Abfrageinitialisierung abgerufen wird.
Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#contacts",
"@odata.nextLink":"https://graph.microsoft.com/beta/contacts/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
"value": [
{
"companyName": "companyName-value",
"department": "department-value",
"displayName": "displayName-value",
"givenName": "givenName-value",
"id": "string (identifier)",
"jobTitle": "jobTitle-value",
"mail": "mail-value",
"mailNickname": "mailNickname-value",
"surname": "surname-value"
}
]
}
Beispiel 2: Auswählen von drei Eigenschaften
Anforderung
Das nächste Beispiel zeigt die ursprüngliche Anforderung mit drei ausgewählten Eigenschaften für Änderungen nachverfolgen und standardmäßigem Antwortverhalten.
GET https://graph.microsoft.com/beta/contacts/delta?$select=displayName,jobTitle,mail
Antwort
Hier sehen Sie ein Beispiel für die Antwort, wenn sie aus @odata.deltaLink
der Abfrageinitialisierung abgerufen wird. Alle drei Eigenschaften sind in der Antwort enthalten, und es ist nicht bekannt, welche sich seit dem Abrufen von @odata.deltaLink
geändert haben.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#contacts",
"@odata.nextLink":"https://graph.microsoft.com/beta/contacts/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
"value": [
{
"displayName": "displayName-value",
"jobTitle": "jobTitle-value",
"mail": null
}
]
}
Beispiel 3: Alternatives minimales Antwortverhalten
Anforderung
Das nächste Beispiel zeigt die ursprüngliche Anforderung mit drei ausgewählten Eigenschaften für Änderungen nachverfolgen und alternativem minimalen Antwortverhalten.
GET https://graph.microsoft.com/beta/contacts/delta?$select=displayName,jobTitle,mail
Prefer: return=minimal
Antwort
Hier sehen Sie ein Beispiel für die Antwort, wenn sie aus @odata.deltaLink
der Abfrageinitialisierung abgerufen wird. Die mail
Eigenschaft ist nicht enthalten, was bedeutet, dass sie sich seit der letzten Deltaabfrage displayName
nicht geändert hat und jobTitle
enthalten ist, was bedeutet, dass sich ihre Werte geändert haben.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#contacts",
"@odata.nextLink":"https://graph.microsoft.com/beta/contacts/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
"value": [
{
"displayName": "displayName-value",
"jobTitle": null
}
]
}