Partager via

driveItem : setRetentionLabel

  • Article

Espace de noms: microsoft.graph

Appliquer (définir) une étiquette de rétention sur un objet driveItem (fichiers et dossiers). Les étiquettes de rétention n’ont pas besoin d’être publiées dans une stratégie d’étiquette de rétention pour être appliquées à l’aide de cette méthode.

Lorsqu’une étiquette de rétention est appliquée à un dossier, tous les éléments du dossier sont étiquetés avec la même étiquette de rétention. Pour plus d’informations sur la résolution des conflits pour les étiquettes de rétention, consultez Une étiquette existante sera-t-elle remplacée ou supprimée ? Pour plus d’informations sur les étiquettes de rétention du point de vue d’un administrateur, voir Utiliser des étiquettes de rétention pour gérer le cycle de vie des documents stockés dans SharePoint.

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 Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)
Déléguée (compte professionnel ou scolaire) Files.Read.All, Files.ReadWrite.All, Sites.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge.
Application Files.Read.All, Files.ReadWrite.All, Sites.ReadWrite.All

Note:Sites.FullControl.All est l’autorisation la moins privilégiée requise pour modifier les étiquettes de rétention qui classifient le contenu en tant qu’enregistrements.

Requête HTTP

PATCH /driveitem/retentionLabel
PATCH /drives/{drive-id}/items/{item-id}/retentionLabel

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez un objet JSON avec le paramètre suivant.

Propriété Type Description
name Chaîne Spécifie le nom de l’étiquette de rétention.

Réponse

Lorsqu’un fichier est appliqué avec une étiquette de rétention pour la première fois, cette méthode renvoie un 201 Created code de réponse et un objet itemRetentionLabel mis à jour dans le corps de la réponse. Les mises à jour suivantes de retentionLabel retournent un 200 OK code de réponse.

Exemples

Demande

L’exemple suivant illustre une demande.

PATCH https://graph.microsoft.com/v1.0/drives/22e064df-3562-4a3c-98c3-74721ca06aa0/items/44d372fc-2eb6-4c85-8538-f3a0386a568f/retentionLabel
Content-Type: application/json

{
  "name": "Retention label for Contracts"
}

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "name": "Retention label for Contracts",
  "retentionSettings": {
    "behaviorDuringRetentionPeriod": "retain",
    "isDeleteAllowed": false,
    "isRecordLocked": false,
    "isMetadataUpdateAllowed": false,
    "isContentUpdateAllowed": false,
    "isLabelUpdateAllowed": false
  },
  "isLabelAppliedExplicitly": false,
  "labelAppliedDateTime": "2022-12-22T10:18:23.6580555+00:00",
  "labelAppliedBy": {
    "user": {
      "id": "56d171c8-a92e-4359-9c4a-38b88ac7eabd",
      "displayName": "Contoso Admin"
    }
  }
}