plannerBucket: delta

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

Важно!

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

Получение вновь созданных, обновленных и удаленных сегментов в плане Планировщика без полного чтения всей коллекции ресурсов. Дополнительные сведения см. в статье Использование разностного запроса для отслеживания изменений в данных Microsoft Graph.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальное обслуживание Правительство США L4 Правительство США L5 (DOD) Китай, обслуживаемый 21Vianet

Разрешения

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

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

HTTP-запрос

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

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

Для отслеживания изменений выполняется один или несколько вызовов разностной функции. Если вы используете параметры запроса, отличные от $deltaToken и $skipToken, их необходимо указать в начальном запросе delta. Microsoft Graph автоматически кодирует указанные параметры в маркере, входящем в состав URL-адреса @odata.nextLink или @odata.deltaLink, включенного в отклик. Параметры запроса нужно указать только один раз в первом запросе. В последующих запросах скопируйте и примените URL-адрес @odata.nextLink или @odata.deltaLink из предыдущего ответа. Этот URL-адрес уже содержит закодированные параметры.

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

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

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения об аутентификации и авторизации.
Content-Type application/json

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

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

Отклик

В случае успеха эта функция возвращает код ответа 200 OK и коллекцию plannerBucket в тексте ответа. Ответ также содержит @odata.nextLink URL-адрес или @odata.deltaLink URL-адрес.

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

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

Дополнительные сведения см. в статье Использование разностного запроса для отслеживания изменений в данных Microsoft Graph. Пример, показывающий, как отслеживать изменения для пользователей, см. в разделе "Получение добавочных изменений для пользователей".

Примеры

В следующем примере показан запрос дельты для объектов plannerBucket, содержащихся в plannerPlanPlan.

Запрос

Ниже показан пример запроса.

GET https://graph.microsoft.com/beta/planner/plans/-W4K7hIak0WlAwgJCn1sEWQABgjH/buckets/delta

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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\\"
    }
  ]
}