Примечание: delta

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Получите набор объектов заметок , добавленных, обновленных или удаленных в папке "Заметки " пользователя с момента последнего разностного запроса. Вызов разностной функции для заметок аналогичен запросу GET, за исключением того, что, применяя маркеры состояния в одном или нескольких из этих вызовов, можно запросить добавочные изменения в заметках.

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) ShortNotes.Read ShortNotes.ReadWrite
Делегированные (личная учетная запись Майкрософт) ShortNotes.Read ShortNotes.ReadWrite
Для приложений Не поддерживается. Не поддерживается.

HTTP-запрос

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

Параметры запроса

При отслеживании изменений в заметках выполняется цикл из одного или нескольких вызовов разностной функции. Если вы используете параметры запроса, отличные от $deltatoken и $skiptoken, их необходимо указать в начальном запросе delta. Microsoft Graph автоматически кодирует все указанные параметры в часть маркера url-адреса @odata.nextLink или @odata.deltaLink , указанного в ответе.

Параметр запроса Тип Описание
$deltatoken String Маркер состояния, возвращенный в URL-адресе @odata.deltaLink предыдущего вызова функции delta, указывающий на завершение этого раунда отслеживания изменений. Сохраните и примените весь URL-адрес @odata.deltaLink , включая этот маркер, в первом запросе следующего раунда отслеживания изменений для этой коллекции.
$skiptoken String Маркер состояния, возвращенный в URL-адресе @odata.nextLink предыдущего вызова разностной функции, указывающий на дальнейшие изменения, которые необходимо отслеживать.

Этот метод также поддерживает $selectпараметры запроса , $filter, $orderbyи $top OData для настройки ответа.

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.

Текст запроса

Не указывайте текст запроса для этого метода.

Отклик

В случае успешного 200 OK выполнения этот метод возвращает код отклика и коллекцию объектов note в тексте отклика. Ответ также содержит URL-адрес @odata.nextLink или URL-адрес @odata.deltaLink .

  • Если возвращается URL-адрес @odata.nextLink , необходимо получить дополнительные страницы данных. Приложение продолжает выполнять запросы, используя URL-адрес @odata.nextLink , пока в ответ не будет включен URL-адрес @odata.deltaLink .
  • Если возвращается URL-адрес @odata.deltaLink , больше страницы данных не возвращаются. Сохраните URL-адрес @odata.deltaLink для использования в следующем разностном вызове.

Примеры

Пример 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