site : delta

Article
04/01/2024

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Obtenez un ensemble de sites nouvellement créés, mis à jour ou supprimés sans avoir à effectuer une lecture complète de l’ensemble de la collection de sites.

Un appel de fonction delta pour des sites est similaire à une requête GET, sauf qu’en appliquant de manière appropriée des jetons d’état dans un ou plusieurs de ces appels, vous pouvez interroger les modifications incrémentielles dans les sites. Il vous permet de gérer et de synchroniser un magasin local des sites d’un utilisateur sans avoir à extraire tous les sites du serveur à chaque fois. L’application appelle l’API sans spécifier de paramètres. Le service commence à énumérer les sites et retourne des pages de modifications apportées à ces sites, accompagnées d’un @odata.nextLink ou d’un @odata.deltaLink. Votre application doit continuer à effectuer des appels à l’aide de @odata.nextLink jusqu’à ce qu’il y ait un @odata.deltaLink dans la réponse.

Après avoir reçu toutes les modifications, vous pouvez les appliquer à votre état local. Pour surveiller les modifications futures, appelez l’API delta à l’aide de la @odata.deltaLink dans la réponse précédente.

Toutes les ressources marquées comme supprimées doivent être supprimées de votre état local.

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)	Sites.Read.All	Sites.ReadWrite.All
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	Sites.Read.All	Sites.ReadWrite.All

Requête HTTP

GET /sites/delta

Paramètres de requête

Dans l’URL de la requête, vous pouvez inclure le paramètre de requête facultatif suivant.

Paramètre	Type	Description
jeton	Chaîne	Si la valeur est `latest`, l’appel retourne une réponse vide avec le dernier jeton delta. Si la valeur est un jeton delta précédent, l’appel retourne le nouvel état depuis que ce jeton a été émis.

Cette méthode prend également en charge les $selectparamètres de requête OData , $expandet $top pour personnaliser la réponse.

En-têtes de demande

En-tête	Valeur
Autorisation	Porteur {token}. Obligatoire.

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 OKcode de réponse et une collection d’objets site dans le corps de la réponse.

En plus de la collection d’objets de site , la réponse inclut l’une des propriétés suivantes.

Nom	Valeur	Description
@odata.nextLink	URL	URL permettant de récupérer la page de modifications disponible suivante s’il existe d’autres modifications dans l’ensemble actuel.
@odata.deltaLink	URL	URL retournée au lieu de @odata.nextLink après le retour de toutes les modifications actuelles. Vous pouvez utiliser cette propriété pour lire l’ensemble de modifications suivant à l’avenir.

Dans certains cas, le service retourne un 410 Gone code de réponse avec une réponse d’erreur contenant l’un des codes d’erreur suivants et un Location en-tête avec un nouveau nextLink qui démarre une nouvelle énumération delta. Cette erreur se produit lorsque le service ne peut pas fournir la liste des modifications pour un jeton donné ; par exemple, si un client tente de réutiliser un ancien jeton après avoir été déconnecté pendant une longue période ou si l’état du serveur a changé et qu’un nouveau jeton est requis.

Une fois l’énumération complète terminée, vous pouvez comparer les sites retournés à votre état local et suivre les instructions en fonction du type d’erreur.

Type d’erreur	Instructions
resyncChangesApplyDifferences	Remplacez les sites locaux par les versions du serveur (y compris les suppressions) si vous êtes sûr que le service était à jour avec vos modifications locales lors de la dernière synchronisation. Téléchargez les modifications locales que le serveur ignore.
resyncChangesUploadDifferences	Chargez tous les sites locaux que le service n’a pas retournés et chargez tous les sites qui diffèrent des versions du serveur. Conservez les deux copies si vous ne savez pas laquelle est la plus à jour.

En plus des erreurs de resynchronisation et pour plus d’informations, consultez Réponses aux erreurs Microsoft Graph et types de ressources.

Exemples

Exemple 1 : Demande initiale

L’exemple suivant montre la requête initiale et comment appeler cette API pour établir votre état local.

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/sites/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.Sites.Delta.GetAsDeltaGetResponseAsync();

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).


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

Importante



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



delta, err := graphClient.Sites().Delta().GetAsDeltaGetResponse(context.Background(), nil)

Importante


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.sites().delta().get();

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/sites/delta')
	.version('beta')
	.get();

Importante


<?php
use Microsoft\Graph\GraphServiceClient;


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


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

Importante


Import-Module Microsoft.Graph.Beta.Sites

Get-MgBetaSiteDelta

Importante


from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


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

Importante

Réponse

L’exemple suivant montre la réponse qui inclut la première page de modifications et la propriété @odata.nextLink qui indique qu’aucun autre site n’est disponible dans l’ensemble de sites actuel. Votre application doit continuer à demander la valeur d’URL de @odata.nextLink jusqu’à ce que toutes les pages de sites soient récupérées.

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

{
  "value": [
    {
      "id": "contoso.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,712a596e-90a1-49e3-9b48-bfa80bee8740",
      "name": "teamSiteA"
    },
    {
      "id": "contoso.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,0271110f-634f-4300-a841-3a8a2e851851",
      "name": "teamSiteB"
    },
    {
      "id": "contoso.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,0271110f-634f-4300-a841-3a8a2e851851",
      "name": "teamSiteC"
    }
  ],
  "@odata.nextLink": "https://graph.microsoft.com/beta/sites/delta?token=1230919asd190410jlka"
}

Exemple 2 : Dernière demande de page

L’exemple suivant montre une requête qui accède à la dernière page d’un ensemble et comment appeler cette API pour mettre à jour votre état local.

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/sites/delta?token=1230919asd190410jlka


// 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.Sites.Delta.GetAsDeltaGetResponseAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Token = "1230919asd190410jlka";
});

Importante


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

Importante



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



requestToken := "1230919asd190410jlka"

requestParameters := &graphsites.SitesDelta()RequestBuilderGetQueryParameters{
	Token: &requestToken,
}
configuration := &graphsites.SitesDelta()RequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

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

Importante


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.sites().delta().get(requestConfiguration -> {
	requestConfiguration.queryParameters.token = "1230919asd190410jlka";
});

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/sites/delta?token=1230919asd190410jlka')
	.version('beta')
	.get();

Importante


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


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

$requestConfiguration = new DeltaRequestBuilderGetRequestConfiguration();
$queryParameters = DeltaRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->token = "1230919asd190410jlka";
$requestConfiguration->queryParameters = $queryParameters;


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

Importante


Import-Module Microsoft.Graph.Beta.Sites

Get-MgBetaSiteDelta -Token "1230919asd190410jlka"

Importante


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

graph_client = GraphServiceClient(credentials, scopes)

query_params = DeltaRequestBuilder.DeltaRequestBuilderGetQueryParameters(
		token = "1230919asd190410jlka",
)

request_configuration = DeltaRequestBuilder.DeltaRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)

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

Importante

Réponse

L’exemple suivant montre la réponse qui indique que le site nommé AllCompany a été supprimé entre la demande initiale et cette demande de mise à jour de l’état local.

La dernière page de sites inclut la propriété @odata.deltaLink qui fournit l’URL qui peut être utilisée ultérieurement pour récupérer les modifications depuis l’ensemble de sites actuel.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#sites",
    "@odata.deltaLink": "https://graph.microsoft.com/beta/sites/delta?$deltatoken=b2vm2fSuZ-V_1Gdq4ublGPD4lReifRNHYMGxkFf0yz2fTqr9U6jMyWv8hihThODJCO_5I7JbpAFLQAIOUzYXhCPl0jlQdjTC1o24iBe81xQyAWJOiP3q1xyMKjlfZUawWok3Njc_LIrrSgrdSydhsVCL6XYpRkYGJ9JDYxFMiJw2vUs1QC_S0cW6hqYQnOimeA918dQZwD8pJI9oUJryV2Ow-7Dj9p18p1I6pFg044k.xipVdgMKlOFIlXzPipsKzlFJbYUTD1sGiFiPe7uZA7Q",
    "value": [
        {
            "createdDateTime": "2024-03-11T02:36:04Z",
            "name": "All Company",
            "displayName": "All Company",
            "isPersonalSite": false,
            "id": "bd565af7-7963-4658-9a77-26e11ac73186",
            "root": {}
        }
    ]
}

Exemple 3 : demande de liaison Delta

Dans certains scénarios, vous pouvez demander la valeur actuelle deltaLink sans énumérer au préalable tous les sites, listes et sites web. Cette suggestion peut être utile si votre application souhaite uniquement connaître les modifications et n’a pas besoin de connaître les sites existants. Pour récupérer la dernière version deltaLink, appelez delta avec le paramètre ?token=latestde chaîne de requête .

Note: Pour conserver une représentation locale complète des ressources, vous devez utiliser delta pour l’énumération initiale. L’utilisation delta est la seule façon de garantir que vous avez lu toutes les données dont vous avez besoin.

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/sites/delta?token=latest


// 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.Sites.Delta.GetAsDeltaGetResponseAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Token = "latest";
});

Importante


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

Importante



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



requestToken := "latest"

requestParameters := &graphsites.SitesDelta()RequestBuilderGetQueryParameters{
	Token: &requestToken,
}
configuration := &graphsites.SitesDelta()RequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

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

Importante


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.sites().delta().get(requestConfiguration -> {
	requestConfiguration.queryParameters.token = "latest";
});

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/sites/delta?token=latest')
	.version('beta')
	.get();

Importante


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


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

$requestConfiguration = new DeltaRequestBuilderGetRequestConfiguration();
$queryParameters = DeltaRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->token = "latest";
$requestConfiguration->queryParameters = $queryParameters;


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

Importante


Import-Module Microsoft.Graph.Beta.Sites

Get-MgBetaSiteDelta -Token "latest"

Importante


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

graph_client = GraphServiceClient(credentials, scopes)

query_params = DeltaRequestBuilder.DeltaRequestBuilderGetQueryParameters(
		token = "latest",
)

request_configuration = DeltaRequestBuilder.DeltaRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)

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

Importante

Réponse

L’exemple suivant illustre la réponse.

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

{
  "value": [ ],
  "@odata.deltaLink": "https://graph.microsoft.com/beta/sites/delta?token=1230919asd190410jlka"
}

site : delta

Autorisations

Requête HTTP

Paramètres de requête

En-têtes de demande

Corps de la demande

Réponse

Exemples

Exemple 1 : Demande initiale

Demande

Réponse

Exemple 2 : Dernière demande de page

Demande

Réponse

Exemple 3 : demande de liaison Delta

Demande

Réponse

Voir aussi

Commentaires

Commentaires

Ressources supplémentaires