plannerBucket : delta

Article
10/28/2023

Espace de noms: microsoft.graph

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 des compartiments nouvellement créés, mis à jour ou supprimés dans un plan Planificateur sans avoir à effectuer une lecture complète de l’ensemble de la collection de ressources. Pour plus d’informations, consultez Utiliser une requête delta pour suivre les modifications apportées aux données Microsoft Graph.

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

Requête HTTP

GET /planner/plans/{plan-id}/buckets/delta

Paramètres de requête

Le suivi des modifications 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. Il vous suffit de spécifier les paramètres de requête la première fois. 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 la même collection de ressources, 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 ressources.

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type	application/json

Corps de la demande

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

Réponse

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

Une @odata.nextLink URL dans l’objet de réponse indique 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.
Une @odata.deltaLink URL dans l’objet de réponse indique qu’aucune autre donnée sur l’état existant de la ressource n’est retournée. Conserver et utiliser l’URL @odata.deltaLink pour en savoir plus sur les modifications apportées à la ressource à l’avenir.

Pour plus d’informations, consultez Utiliser une requête delta pour suivre les modifications apportées aux données Microsoft Graph. Pour obtenir un exemple qui montre comment suivre les modifications apportées aux utilisateurs, consultez Obtenir des modifications incrémentielles pour les utilisateurs.

Exemples

L’exemple suivant montre une demande de delta sur des objets plannerBucket contenus par un plannerPlan.

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/planner/plans/-W4K7hIak0WlAwgJCn1sEWQABgjH/buckets/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.Planner.Plans["{plannerPlan-id}"].Buckets.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 planner plans buckets delta get --planner-plan-id {plannerPlan-id}

Importante



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



delta, err := graphClient.Planner().Plans().ByPlannerPlanId("plannerPlan-id").Buckets().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.planner().plans().byPlannerPlanId("{plannerPlan-id}").buckets().delta().get();

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/planner/plans/-W4K7hIak0WlAwgJCn1sEWQABgjH/buckets/delta')
	.version('beta')
	.get();

Importante


<?php
use Microsoft\Graph\GraphServiceClient;


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


$result = $graphServiceClient->planner()->plans()->byPlannerPlanId('plannerPlan-id')->buckets()->delta()->get()->wait();

Importante


from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


result = await graph_client.planner.plans.by_planner_plan_id('plannerPlan-id').buckets.delta.get()

Importante

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#plannerBucket",
  "@odata.deltaLink": "https://graph.microsoft.com/beta/planner/plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/buckets?deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
  "value": [
    {
      "@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
      "id": "iz1mmIxX7EK0Yj7DmRsMs2QAEDXH",
      "name": "This is a bucket",
      "planId": "-W4K7hIak0WlAwgJCn1sEWQABgjH",
      "orderHint": "8585371316800245114P\\"
    }
  ]
}

plannerBucket : delta

Autorisations

Requête HTTP

Paramètres de requête

En-têtes de demande

Corps de la demande

Réponse

Exemples

Demande

Réponse

Commentaires

Commentaires

Ressources supplémentaires