plannerPlan: archive

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 plannerTasks e plannerBuckets no plano.

Uma entidade arquivada é somente leitura. Entidades arquivadas não podem ser atualizadas.

Um plano arquivado pode ser desarquivado.

Todas as entidades arquivadas podem ser excluídas.

As tarefas arquivadas não são incluídas na resposta para a lista de tarefas atribuídas a um usuário.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA 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 menos privilegiadas Permissões com privilégios mais elevados
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

Cabeçalhos de solicitação

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 a ser arquivado. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON dos parâmetros.

A tabela a seguir lista os parâmetros necessários quando você chama essa ação.

Parâmetro Tipo Descrição
Justificação Cadeia de caracteres Motivo pelo qual o plano está sendo 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 os aplicativos devem manipular para esse 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"
}

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