名前空間: microsoft.graph
Microsoft To Do で追加、削除、または削除された todoTaskList リソースのセットを取得します。
todoTaskList のデルタ関数呼び出しは GET 要求に似ていますが、これらの呼び出しの 1 つ以上に状態トークンを適切に適用することで、todoTaskList の増分変更を照会できる点が異なります。 これにより、毎回すべての todoTaskList を サーバーからフェッチすることなく、ユーザーの todoTaskList のローカル ストアを維持および同期できます。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
|---|---|---|---|
| ✅ | ✅ | ✅ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | Tasks.ReadWrite | 注意事項なし。 |
| 委任 (個人用 Microsoft アカウント) | Tasks.ReadWrite | 注意事項なし。 |
| アプリケーション | Tasks.Read.All | Tasks.ReadWrite.All |
HTTP 要求
GET /me/todo/lists/delta
GET /users/{id|userPrincipalName}/todo/lists/delta
クエリ パラメーター
todoTaskList リソースの変更を追跡すると、1 つ以上のデルタ関数呼び出しのラウンドが発生します。 任意のクエリ パラメーター ($deltatoken と$skiptoken以外) を使用する場合は、最初のデルタ要求でこれを指定する必要があります。 Microsoft Graph は、応答で提供される @odata.nextLink または @odata.deltaLink の URL のトークン部分に指定したパラメーターを自動的にエンコードします。
必要なクエリ パラメーターを前もって 1 回指定しておくだけで済みます。
後続の要求では、前の応答の @odata.nextLink または @odata.deltaLink URL をコピーして適用するだけです。その URL には、エンコードされた目的のパラメーターが既に含まれています。
| クエリ パラメーター | 種類 | 説明 |
|---|---|---|
| $deltatoken | string | 同じ todoTaskList コレクションに対する前のデルタ関数呼び出しの@odata.deltaLink URL で返された状態トークン。変更追跡のラウンドの完了を示します。 このコレクションについて、このトークンを含む、@odata.deltaLink URL 全体を次の変更追跡のラウンドの最初の要求に保存し、適用します。 |
| $skiptoken | string | 前のデルタ関数呼び出しの@odata.nextLink URL で返された状態トークン。同じ todoTaskList コレクションで追跡するその他の変更があることを示します。 |
OData クエリ パラメーター
GET 要求と同様に、 $select クエリ パラメーターを使用して、最適なパフォーマンスを得るために必要なプロパティのみを指定できます。
id プロパティは常に返されます。
要求ヘッダー
| 名前 | 型 | 説明 |
|---|---|---|
| Authorization | string | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
| Content-Type | string | application/json. Required. |
| Prefer | string | odata.maxpagesize={x}。 省略可能。 |
応答
成功した場合、このメソッドは応答コード 200 OK と、応答本文の todoTaskList コレクション オブジェクトを返します。
例
要求
次の例は、最初の デルタ 関数呼び出しを行い、応答本文の todoTaskList の最大数を 2 に制限する方法を示しています。
todoTaskList の変更を追跡するには、1 つ以上のデルタ関数呼び出しを行い、適切な状態トークンを使用して、最後のデルタ クエリ以降の増分変更のセットを取得します。
リスト内の todoTaskList の追跡と todoTask リソースの追跡のメイン違いは、デルタ クエリ要求 URL と、todoTask コレクションではなく todoTaskList を返すクエリ応答にあります。
GET https://graph.microsoft.com/v1.0/me/todo/lists/delta
応答
要求が成功すると、応答には状態トークンが含まれます。これは、skipToken
( @odata.nextLink 応答ヘッダー内) または deltaToken ( @odata.deltaLink 応答ヘッダー内)。
それぞれ、ラウンドを続行するか、そのラウンドのすべての変更の取得を完了したかを示します。
以下の応答は、@odata.nextLink 応答ヘッダーに含まれる skipToken を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.deltaLink":"https://graph.microsoft.com/v1.0/me/todo/lists/delta?$skiptoken=ldfdgdgfoT5csv4k99nvQqyku0jaGqMhc6XyFff5qQTQ7RJOr",
"value": [
{
"@odata.etag":"W/\"4rfRVIPi9EqXgDbc8U7HGwADLLQ93w==\"",
"displayName":"List1",
"isOwner":true,
"isShared":false,
"wellknownListName":"none",
"id":"AQMkADMwNTcyZjQzLTdkMGItNDdjMy04ZTYwLTJhYmUzNGI5ZD"
}
]
}