orgContact : delta

Article
10/02/2023

Espace de noms: microsoft.graph

Obtenez les contacts organisationnels nouvellement créés, mis à jour ou supprimés sans avoir à effectuer une lecture complète de l’ensemble de la collection. Pour plus d’informations, voir suivi des modifications.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	✅	✅	✅

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	OrgContact.Read.All	Directory.Read.All, Directory.ReadWrite.All
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	OrgContact.Read.All	Directory.Read.All, Directory.ReadWrite.All

Requête HTTP

Pour commencer le suivi des modifications, vous effectuez une requête incluant la fonction delta sur la ressource contacts.

GET /contacts/delta

Paramètres de requête

Le suivi des modifications dans les contacts de l’organisation entraîne une série d’appels de fonction delta . Si vous utilisez un paramètre de requête (autre que $deltatoken et $skiptoken), vous devez le spécifier dans la requête delta initiale. Microsoft Graph code automatiquement les paramètres spécifiés dans la partie jeton du @odata.nextLink ou de l’URL @odata.deltaLink fournie dans la réponse.

Vous n’avez besoin de spécifier des paramètres de requête qu’une fois à l’avance.

Dans les requêtes suivantes, copiez et appliquez l’URL @odata.nextLink ou @odata.deltaLink de la réponse précédente. Cette URL inclut déjà les paramètres encodés.

Paramètre de requête	Type	Description
$deltatoken	string	Jeton d’état retourné dans l’URL `@odata.deltaLink` de l’appel de fonction delta précédent pour le même organization collection de contacts, indiquant la fin de cette série de suivi des modifications. Enregistrez et appliquez l’URL entière `@odata.deltaLink` , y compris ce jeton, dans la première requête de la série suivante de suivi des modifications pour cette collection.
$skiptoken	string	Jeton d’état retourné dans l’URL `@odata.nextLink` de l’appel de fonction delta précédent, indiquant que d’autres modifications doivent être suivies dans la même collection de contacts organization.

Paramètres de requête OData

Cette méthode prend en charge les paramètres de requête OData facultatifs pour vous aider à personnaliser la réponse.

Vous pouvez utiliser un paramètre de requête $select comme dans toute requête GET pour spécifier uniquement les propriétés dont vous avez besoin pour de meilleures performances. La propriété id est toujours renvoyée.
La prise en charge $filterde :
- La seule expression $filter prise en charge concerne le suivi des modifications sur un objet spécifique : $filter=id+eq+{value}. Vous pouvez filtrer plusieurs objets. Par exemple, https://graph.microsoft.com/v1.0/contacts/delta/?$filter= id eq '477e9fc6-5de7-4406-bb2a-7e5c83c9ffff' or id eq '004d6a07-fe70-4b92-add5-e6e37b8affff'. Il existe une limite de 50 objets filtrés.

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Préférence	return=minimal. Spécifiant cet en-tête avec une demande utilisant un `@odata.deltaLink` retourne uniquement les propriétés d’objet qui ont été modifiées depuis la dernière passe. Facultatif.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et un objet de collection orgContact dans le corps de la réponse. La réponse inclut également une URL @odata.nextLink ou une URL @odata.deltaLink.

Si une URL @odata.nextLink est renvoyée :
- Cela indique qu’il existe des pages de données supplémentaires à récupérer dans la session. L’application continue d’effectuer des requêtes à l’aide de l’URL @odata.nextLink jusqu’à ce que la réponse contienne une URL @odata.deltaLink.
- La réponse inclut le même ensemble de propriétés que dans la demande de requête delta initiale. Cela vous permet de capturer l’état actuel complet des objets lors du lancement de l’exécution du cycle delta.
Si une URL @odata.deltaLink est renvoyée :
- Cela indique qu’il n’y a plus de données sur l’état existant de la ressource à retourner. Enregistrez et utilisez l’URL @odata.deltaLink pour étudier comment changer la ressource dans la passe suivante.
- Pour avez le choix de pouvoir spécifier l’en-tête Prefer:return=minimal à inclure dans les valeurs de réponse uniquement pour les propriétés qui ont été modifiées depuis que le @odata.deltaLink a été émis.

Par défaut : retourne les mêmes propriétés que la requête delta initiale

Par défaut, les requêtes utilisant un @odata.deltaLink ou @odata.nextLink renvoient les mêmes propriétés sélectionnées dans la requête delta initiale comme suit :

Si la propriété a changé, la nouvelle valeur est incluse dans la réponse. Cela inclut les propriétés définies pour la valeur null.
Si la propriété n’a pas changé, l’ancienne valeur est incluse dans la réponse.
Si la propriété n’a jamais été définie auparavant, elle n’est pas incluse dans la réponse.

En alternative : retourner uniquement les propriétés modifiées

Ajout d’un en-tête de la demande facultatif ( prefer:return=minimal ) engendre le comportement suivant :

Si la propriété a changé, la nouvelle valeur est incluse dans la réponse. Cela inclut les propriétés définies pour la valeur null.
Si la propriété n’a pas changé, la propriété n’est pas incluse dans la réponse. (Différent du comportement par défaut).

Exemples

Exemple 1 : propriétés par défaut

Demande

Voici un exemple de demande. Comme il n’existe aucun $select paramètre, un ensemble de propriétés par défaut est suivi et retourné.

GET https://graph.microsoft.com/v1.0/contacts/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.Contacts.Delta.GetAsDeltaGetResponseAsync();


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc contacts delta get



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



delta, err := graphClient.Contacts().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.contacts().delta().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/contacts/delta')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


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


$result = $graphServiceClient->contacts()->delta()->get()->wait();


Import-Module Microsoft.Graph.Identity.DirectoryManagement

Get-MgContactDelta


from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


result = await graph_client.contacts.delta.get()

Réponse

Voici un exemple de réponse lors de l’utilisation @odata.deltaLink obtenue à partir de l’initialisation de la requête.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#contacts",
  "@odata.nextLink":"https://graph.microsoft.com/v1.0/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"
    }
  ]
}

Exemple 2 : sélection de trois propriétés

Demande

L’exemple suivant montre la requête initiale sélectionnant trois propriétés pour le suivi des modifications, avec le comportement de réponse par défaut.

GET https://graph.microsoft.com/v1.0/contacts/delta?$select=displayName,jobTitle,mail


// 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.Contacts.Delta.GetAsDeltaGetResponseAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Select = new string []{ "displayName","jobTitle","mail" };
});


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc contacts delta get --select "displayName,jobTitle,mail"



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestParameters := &graphcontacts.ContactsDelta()RequestBuilderGetQueryParameters{
	Select: [] string {"displayName","jobTitle","mail"},
}
configuration := &graphcontacts.ContactsDelta()RequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

delta, err := graphClient.Contacts().Delta().GetAsDeltaGetResponse(context.Background(), configuration)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.contacts().delta().get(requestConfiguration -> {
	requestConfiguration.queryParameters.select = new String []{"displayName", "jobTitle", "mail"};
});


const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/contacts/delta')
	.select('displayName,jobTitle,mail')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Contacts\Delta\DeltaRequestBuilderGetRequestConfiguration;


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

$requestConfiguration = new DeltaRequestBuilderGetRequestConfiguration();
$queryParameters = DeltaRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->select = ["displayName","jobTitle","mail"];
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->contacts()->delta()->get($requestConfiguration)->wait();


Import-Module Microsoft.Graph.Identity.DirectoryManagement

Get-MgContactDelta -Property "displayName,jobTitle,mail"


from msgraph import GraphServiceClient
from msgraph.generated.contacts.delta.delta_request_builder import DeltaRequestBuilder

graph_client = GraphServiceClient(credentials, scopes)

query_params = DeltaRequestBuilder.DeltaRequestBuilderGetQueryParameters(
		select = ["displayName","jobTitle","mail"],
)

request_configuration = DeltaRequestBuilder.DeltaRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.contacts.delta.get(request_configuration = request_configuration)

Réponse

Voici un exemple de réponse lors de l’utilisation @odata.deltaLink obtenue à partir de l’initialisation de la requête. Les trois propriétés sont incluses dans la réponse et on ne sait pas lesquelles ont changé depuis l’obtention @odata.deltaLink de .

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#contacts",
  "@odata.nextLink":"https://graph.microsoft.com/v1.0/contacts/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
  "value": [
    {
      "displayName": "displayName-value",
      "jobTitle": "jobTitle-value",
      "mail": null
    }
  ]
}

Exemple 3 : comportement de réponse minimal alternatif

Demande

L’exemple suivant montre la requête initiale sélectionnant trois propriétés pour le suivi des modifications, avec le comportement de réponse minimal alternatif.

GET https://graph.microsoft.com/v1.0/contacts/delta?$select=displayName,jobTitle,mail
Prefer: return=minimal


// 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.Contacts.Delta.GetAsDeltaGetResponseAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Select = new string []{ "displayName","jobTitle","mail" };
	requestConfiguration.Headers.Add("Prefer", "return=minimal");
});


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc contacts delta get --select "displayName,jobTitle,mail"



import (
	  "context"
	  abstractions "github.com/microsoft/kiota-abstractions-go"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphcontacts "github.com/microsoftgraph/msgraph-sdk-go/contacts"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


headers := abstractions.NewRequestHeaders()
headers.Add("Prefer", "return=minimal")

requestParameters := &graphcontacts.ContactsDelta()RequestBuilderGetQueryParameters{
	Select: [] string {"displayName","jobTitle","mail"},
}
configuration := &graphcontacts.ContactsDelta()RequestBuilderGetRequestConfiguration{
	Headers: headers,
	QueryParameters: requestParameters,
}

delta, err := graphClient.Contacts().Delta().GetAsDeltaGetResponse(context.Background(), configuration)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.contacts().delta().get(requestConfiguration -> {
	requestConfiguration.queryParameters.select = new String []{"displayName", "jobTitle", "mail"};
	requestConfiguration.headers.add("Prefer", "return=minimal");
});


const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/contacts/delta')
	.header('Prefer','return=minimal')
	.select('displayName,jobTitle,mail')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Contacts\Delta\DeltaRequestBuilderGetRequestConfiguration;


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

$requestConfiguration = new DeltaRequestBuilderGetRequestConfiguration();
$headers = [
		'Prefer' => 'return=minimal',
	];
$requestConfiguration->headers = $headers;

$queryParameters = DeltaRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->select = ["displayName","jobTitle","mail"];
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->contacts()->delta()->get($requestConfiguration)->wait();


Import-Module Microsoft.Graph.Identity.DirectoryManagement

Get-MgContactDelta -Property "displayName,jobTitle,mail"


from msgraph import GraphServiceClient
from msgraph.generated.contacts.delta.delta_request_builder import DeltaRequestBuilder

graph_client = GraphServiceClient(credentials, scopes)

query_params = DeltaRequestBuilder.DeltaRequestBuilderGetQueryParameters(
		select = ["displayName","jobTitle","mail"],
)

request_configuration = DeltaRequestBuilder.DeltaRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)
request_configuration.headers.add("Prefer", "return=minimal")


result = await graph_client.contacts.delta.get(request_configuration = request_configuration)

Réponse

Voici un exemple de réponse lors de l’utilisation @odata.deltaLink obtenue à partir de l’initialisation de la requête. La mail propriété n’est pas incluse, ce qui signifie qu’elle n’a pas changé depuis la dernière requête delta ; displayName et jobTitle sont incluses, ce qui signifie que leurs valeurs ont changé.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#contacts",
  "@odata.nextLink":"https://graph.microsoft.com/v1.0/contacts/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
  "value": [
    {
      "displayName": "displayName-value",
      "jobTitle": null
    }
  ]
}

Utiliser la requête delta pour suivre les modifications apportées aux données Microsoft Graph.

orgContact : delta

Autorisations

Requête HTTP

Paramètres de requête

Paramètres de requête OData

En-têtes de demande

Corps de la demande

Réponse

Par défaut : retourne les mêmes propriétés que la requête delta initiale

En alternative : retourner uniquement les propriétés modifiées

Exemples

Exemple 1 : propriétés par défaut

Demande

Réponse

Exemple 2 : sélection de trois propriétés

Demande

Réponse

Exemple 3 : comportement de réponse minimal alternatif

Demande

Réponse

Commentaires

Commentaires

Ressources supplémentaires

orgContact : delta

Autorisations

Requête HTTP

Paramètres de requête

Paramètres de requête OData

En-têtes de demande

Corps de la demande

Réponse

Par défaut : retourne les mêmes propriétés que la requête delta initiale

En alternative : retourner uniquement les propriétés modifiées

Exemples

Exemple 1 : propriétés par défaut

Demande

Réponse

Exemple 2 : sélection de trois propriétés

Demande

Réponse

Exemple 3 : comportement de réponse minimal alternatif

Demande

Réponse

Contenu connexe

Commentaires

Commentaires

Ressources supplémentaires