Partager via


plannerPlan : archive

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Archiver un objet plannerPlan . L’archivage d’un plan archive également les tâches plannerTasks et plannerBuckets dans le plan.

Une entité archivée est en lecture seule. Les entités archivées ne peuvent pas être mises à jour.

Un plan archivé peut être désarchivé.

Toutes les entités archivées peuvent être supprimées.

Les tâches archivées ne sont pas incluses dans la réponse pour la liste des tâches affectées à un utilisateur.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) Tasks.ReadWrite Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Tasks.ReadWrite.All Non disponible.

Requête HTTP

POST /planner/plans/{planId}/archive

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire.
Content-Type application/json. Obligatoire.
If-Match Dernière valeur ETag connue pour le plannerPlan à archiver. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON des paramètres.

Le tableau suivant répertorie les paramètres requis lorsque vous appelez cette action.

Paramètre Type Description
justification Chaîne Raison pour laquelle le plan est archivé.

Réponse

Si elle réussit, cette action renvoie un code de réponse 204 No Content.

Cette méthode peut retourner l’un des codes d’état HTTP. Les erreurs les plus courantes que les applications doivent gérer pour cette méthode sont les réponses 400 et 403. Pour plus d’informations sur ces erreurs, consultez Conditions d’erreur courantes du Planificateur.

Exemples

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/planner/plans/{planId}/archive
Content-Type: application/json

{
  "justification": "String"
}

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 204 No Content