plannerBucket: delta

Статья
08/23/2023

Пространство имен: 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, включенного в отклик. Параметры запроса нужно указать только один раз в первом запросе. В последующих запросах скопируйте и примените @odata.nextLink URL-адрес или @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 .

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

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

Примеры

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

Запрос

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

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

Важно!

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

Подробнее о том, как добавить 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-запрос

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

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

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

Отклик

Примеры

Запрос

Отклик

Обратная связь

Обратная связь

Дополнительные ресурсы