Partager via

driveItem : lockOrUnlockRecord

Espace de noms: microsoft.graph

Verrouillez ou déverrouillez une étiquette de rétention sur un élément driveItem qui classifie le contenu en tant qu’enregistrements.

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.

Pour plus d’informations sur la façon dont vous pouvez verrouiller et déverrouiller les étiquettes de rétention, voir Utiliser le contrôle de version d’enregistrement pour mettre à jour les enregistrements stockés dans SharePoint ou OneDrive.

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

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

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

Requête HTTP

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
retentionSettings retentionLabelSettings Paramètres de rétention appliqués à l’élément.

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et un objet itemRetentionLabel mis à jour dans le corps de la réponse.

Exemples

Demande

L’exemple suivant illustre une demande.

PATCH https://graph.microsoft.com/v1.0/drives/b!t18F8ybsHUq1z3LTz8xvZqP8zaSWjkFNhsME-Fepo75dTf9vQKfeRblBZjoSQrd7/items/01NKDM7HMOJTVYMDOSXFDK2QJDXCDI3WUK/retentionLabel
Content-Type: application/json

{
  "retentionSettings": {
    "isRecordLocked": true
  }
}

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": true,
    "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"
    }
  }
}
  • Last updated on