注: delta

名前空間: microsoft.graph

重要

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

最後のデルタ クエリ以降にユーザーの Notes フォルダーで追加、更新、または削除されたノート オブジェクトのセットを取得します。 ノートの デルタ 関数呼び出しは GET 要求に似ていますが、これらの呼び出しの 1 つ以上に 状態トークン を適切に適用することで、ノートの増分変更を照会できる点が異なります。

アクセス許可

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

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

HTTP 要求

GET /me/notes/delta
GET /users/{id | userPrincipalName}/notes/delta

クエリ パラメーター

ノートの変更を追跡すると、1 つ以上の デルタ 関数呼び出しのラウンドが発生します。 任意のクエリ パラメーター ($deltatoken と$skiptoken以外) を使用する場合は、最初のデルタ要求でこれを指定する必要があります。 Microsoft Graph は、指定したパラメーターを応答で指定された @odata.nextLink または @odata.deltaLink URL のトークン部分に自動的にエンコードします。

クエリ パラメーター 種類 説明
$deltatoken 文字列 前のデルタ関数呼び出しの@odata.deltaLink URL で返された状態トークン。変更追跡のラウンドの完了を示します。 このトークンを含む @odata.deltaLink URL 全体を、そのコレクションの次の一連の変更追跡の最初の要求に保存して適用します。
$skiptoken 文字列 以前のデルタ関数呼び出しの @odata.nextLink URL で返された状態トークン。追跡するその他の変更を示します。

このメソッドでは、 $select、 $filter、 $orderby、 $top OData クエリ パラメーターもサポートされ、応答のカスタマイズに役立ちます。

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。

要求本文

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

応答

成功した場合、このメソッドは 200 OK 応答コードと応答本文の ノート オブジェクトのコレクションを返します。 応答には、 @odata.nextLink URL または @odata.deltaLink URL も含まれます。

  • @odata.nextLink URL が返された場合、さらに多くのデータ ページが取得されます。 アプリケーションは、 応答に@odata.deltaLink URL が含まれるまで 、@odata.nextLink URL を使用して要求を行い続けます。
  • @odata.deltaLink URL が返された場合、それ以上のデータ ページは返されません。 次のデルタ呼び出しで使用する@odata.deltaLink URL を保存します。

例

例 1: 初期同期要求

次の例は、すべてのノートを取得するための初期同期要求を示しています。

要求

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

GET https://graph.microsoft.com/beta/me/notes/delta

応答

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

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('user-id')/notes",
  "@odata.deltaLink": "https://graph.microsoft.com/beta/me/notes/delta?$deltatoken=abc123def456",
  "value": [
    {
      "id": "AAMkAGI2THVSAAA=",
      "changeKey": "CQAAABYAAABE",
      "createdDateTime": "2024-01-15T10:00:00Z",
      "lastModifiedDateTime": "2024-01-20T11:00:00Z",
      "categories": [],
      "subject": "Updated Note",
      "body": {
        "contentType": "html",
        "content": "<html><body>Updated content</body></html>"
      },
      "bodyPreview": "Updated content",
      "isDeleted": false,
      "hasAttachments": false
    }
  ]
}

例 2: 後続のデルタ要求

次の例は、前の応答のデルタ トークンを使用した後続の同期要求を示しています。 新規、更新、削除されたノートが返されます。

要求

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

GET https://graph.microsoft.com/beta/me/notes/delta?$deltatoken=abc123def456

応答

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

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('user-id')/notes",
  "@odata.deltaLink": "https://graph.microsoft.com/beta/me/notes/delta?$deltatoken=xyz789new",
  "value": [
    {
      "id": "AAMkAGI2NEWITEM=",
      "changeKey": "CQAAABYAAABF",
      "subject": "New Note",
      "bodyPreview": "New content",
      "createdDateTime": "2024-01-21T08:00:00Z",
      "lastModifiedDateTime": "2024-01-21T08:00:00Z"
    },
    {
      "@removed": {
        "reason": "deleted"
      },
      "id": "AAMkAGI2DELETED="
    }
  ]
}
  • Last updated on