plannerBucket: delta

[アーティクル]
10/28/2023

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

リソースコレクション全体の完全な読み取りを実行することなく、Planner プランで新しく作成、更新、または削除されたバケットを取得します。詳細については、「デルタクエリを使用して Microsoft Graph データの変更を追跡する」を参照してください。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	✅	❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。これらのアクセス許可の詳細については、アクセス許可のリファレンスを参照してください。

アクセス許可の種類	最小特権アクセス許可	特権の高いアクセス許可
委任 (職場または学校のアカウント)	Tasks.Read	注意事項なし。
委任 (個人用 Microsoft アカウント)	サポートされていません。	サポートされていません。
アプリケーション	Tasks.Read.All	注意事項なし。

HTTP 要求

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

クエリパラメーター

変更を追跡すると、1 つ以上の デルタ 関数呼び出しのラウンドが発生します。任意のクエリパラメーター ($deltaToken と$skipToken以外) を使用する場合は、最初のデルタ要求でこれを指定する必要があります。 Microsoft Graph は、応答で提供される @odata.nextLink または @odata.deltaLink の URL のトークン部分に指定したパラメーターを自動的にエンコードします。すべてのクエリパラメーターを最初に 1 回指定しておくだけで済みます。後続の要求では、前の応答の @odata.nextLink または @odata.deltaLink URL をコピーして適用します。その URL には、エンコードされたパラメーターが既に含まれています。

クエリパラメーター	種類	説明
$deltaToken	string	同じリソースコレクションに対する`@odata.deltaLink`前のデルタ関数呼び出しの URL で返された状態トークン。変更追跡のラウンドの完了を示します。そのコレクションの次の変更追跡の次のラウンドの最初の要求で、このトークンを含む URL 全体 `@odata.deltaLink` を保存して適用します。
$skipToken	string	前のデルタ関数呼び出しの URL で`@odata.nextLink`返される状態トークン。同じリソースコレクションで追跡する必要がある変更が追加されていることを示します。

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須です。認証と承認の詳細については、こちらをご覧ください。
Content-Type	application/json

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、この関数は 200 OK 応答コードと、応答本文の plannerBucket コレクションを返します。応答には、または @odata.deltaLink URL も含まれます@odata.nextLink。

応答オブジェクトの URL は @odata.nextLink 、セッションで取得するデータの追加ページを示します。アプリケーションは@odata.deltaLink URL が応答に含まれるまで@odata.nextLink URLを使用して要求を続けます。
応答オブジェクトの URL は @odata.deltaLink 、リソースの既存の状態に関するデータがそれ以上返されていないことを示します。 URL を @odata.deltaLink 永続化して使用して、今後のリソースの変更について学習します。

詳細については、「デルタクエリを使用して Microsoft Graph データの変更を追跡する」を参照してください。ユーザーの変更を追跡する方法を示す例については、「ユーザーの増分変更を取得する」を参照してください。

例

次の例は、plannerPlan に含まれる plannerBucket オブジェクトに対するデルタの要求を示しています。

要求

次の例は要求を示しています。

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();

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用可能なすべての型、プロパティ、API がサポートされているわけではありません。 SDK を使用してベータ API にアクセスする方法の詳細については、「ベータ API で Microsoft Graph SDK を使用する」を参照してください。

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta planner plans buckets delta get --planner-plan-id {plannerPlan-id}

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



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)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


// 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();

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
	authProvider,
};

const client = Client.init(options);

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

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


<?php
use Microsoft\Graph\GraphServiceClient;


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


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

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


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

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

アクセス許可

HTTP 要求

クエリパラメーター

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

フィードバック

その他のリソース

plannerBucket: delta

アクセス許可

HTTP 要求

クエリ パラメーター

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

フィードバック

その他のリソース

クエリパラメーター