Namespace: microsoft.graph
Importante
As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Arquivo um objeto plannerPlan. Arquivar um plano também arquiva os plannerTasks e plannerBuckets no plano.
Uma entidade arquivada é só de leitura. Não é possível atualizar as entidades arquivadas.
Um plano arquivado pode ser arquivado.
Todas as entidades arquivadas podem ser eliminadas.
As tarefas arquivadas não estão incluídas na resposta para a lista de tarefas atribuídas a um utilizador.
Esta API está disponível nas seguintes implementações de cloud nacionais.
| Serviço global |
US Government L4 |
US Government L5 (DOD) |
China operada pela 21Vianet |
| ✅ |
✅ |
✅ |
❌ |
Permissões
Uma das seguintes permissões é necessária para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.
| Tipo de permissão |
Permissões com menos privilégios |
Permissões com privilégios superiores |
| Delegado (conta corporativa ou de estudante) |
Tasks.ReadWrite |
Indisponível. |
| Delegado (conta pessoal da Microsoft) |
Sem suporte. |
Sem suporte. |
| Application |
Tasks.ReadWrite.All |
Indisponível. |
Solicitação HTTP
POST /planner/plans/{planId}/archive
| Nome |
Descrição |
| Autorização |
{token} de portador. Obrigatório. |
| Content-Type |
application/json. Obrigatório. |
| If-Match |
Último valor de ETag conhecido para o plannerPlan ser arquivado. Obrigatório. |
Corpo da solicitação
No corpo do pedido, forneça uma representação JSON dos parâmetros.
A tabela seguinte lista os parâmetros que são necessários quando chama esta ação.
| Parâmetro |
Tipo |
Descrição |
| justificação |
Cadeia de caracteres |
Motivo pelo qual o plano está a ser arquivado. |
Resposta
Se tiver êxito, esta ação retornará um código de resposta 204 No Content.
Este método pode retornar qualquer um dos códigos de status de HTTP. Os erros mais comuns que as aplicações devem processar para este método são as respostas 400 e 403. Saiba mais sobre esses erros em Condições de erro comuns do Planner.
Exemplos
Solicitação
O exemplo a seguir mostra uma solicitação.
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)
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 204 No Content