Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Архив объект plannerPlan. Архивация плана также архивирует plannerTasks и plannerBuckets в плане.
Архивная сущность доступна только для чтения. Архивные сущности не могут быть обновлены.
Архивный план может быть неархивирован.
Все архивные сущности можно удалить.
Архивные задачи не включаются в ответ на список задач, назначенных пользователю.
Этот API доступен в следующих национальных облачных развертываниях.
| Глобальная служба |
Правительство США L4 |
Правительство США L5 (DOD) |
Китай управляется 21Vianet |
| ✅ |
✅ |
✅ |
❌ |
Разрешения
Для вызова этого API требуется одно из следующих разрешений. Дополнительные сведения, включая сведения о том, как выбрать разрешения, см. в статье Разрешения.
| Тип разрешения |
Разрешения с наименьшими привилегиями |
Более высокие привилегированные разрешения |
| Делегированные (рабочая или учебная учетная запись) |
Tasks.ReadWrite |
Недоступно. |
| Делегированные (личная учетная запись Майкрософт) |
Не поддерживается. |
Не поддерживается. |
| Приложение |
Tasks.ReadWrite.All |
Недоступно. |
HTTP-запрос
POST /planner/plans/{planId}/archive
| Имя |
Описание |
| Авторизация |
Bearer {token}. Обязательно. |
| Content-Type |
application/json. Обязательно. |
| If-Match |
Последнее известное значение ETag для заархивированного плана plannerPlan . Обязательно. |
Текст запроса
В тексте запроса укажите представление параметров в формате JSON.
В следующей таблице перечислены параметры, необходимые при вызове этого действия.
| Параметр |
Тип |
Описание |
| оправдание |
String |
Причина архивирования плана. |
Отклик
В случае успешного выполнения это действие возвращает код отклика 204 No Content.
Этот метод может возвращать любой из кодов состояния HTTP. Наиболее распространенными ошибками, которые приложения должны обрабатывать для этого метода, являются ответы 400 и 403. Дополнительные сведения об этих ошибках см. в статье Общие Планировщик условия ошибок.
Примеры
Запрос
Ниже показан пример запроса.
POST https://graph.microsoft.com/beta/planner/plans/{planId}/archive
Content-Type: application/json
{
"justification": "String"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Planner.Plans.Item.Archive;
var requestBody = new ArchivePostRequestBody
{
Justification = "String",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Planner.Plans["{plannerPlan-id}"].Archive.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphplanner "github.com/microsoftgraph/msgraph-beta-sdk-go/planner"
//other-imports
)
requestBody := graphplanner.NewArchivePostRequestBody()
justification := "String"
requestBody.SetJustification(&justification)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Planner().Plans().ByPlannerPlanId("plannerPlan-id").Archive().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.planner.plans.item.archive.ArchivePostRequestBody archivePostRequestBody = new com.microsoft.graph.beta.planner.plans.item.archive.ArchivePostRequestBody();
archivePostRequestBody.setJustification("String");
graphClient.planner().plans().byPlannerPlanId("{plannerPlan-id}").archive().post(archivePostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const archive = {
justification: 'String'
};
await client.api('/planner/plans/{planId}/archive')
.version('beta')
.post(archive);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Planner\Plans\Item\Archive\ArchivePostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ArchivePostRequestBody();
$requestBody->setJustification('String');
$graphServiceClient->planner()->plans()->byPlannerPlanId('plannerPlan-id')->archive()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Planner
$params = @{
justification = "String"
}
Invoke-MgBetaArchivePlannerPlan -PlannerPlanId $plannerPlanId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.planner.plans.item.archive.archive_post_request_body import ArchivePostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ArchivePostRequestBody(
justification = "String",
)
await graph_client.planner.plans.by_planner_plan_id('plannerPlan-id').archive.post(request_body)
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 204 No Content