Freigeben über


driveItem: setRetentionLabel

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Anwenden (Festlegen) einer Aufbewahrungsbezeichnung auf ein driveItem -Objekt (Dateien und Ordner). Aufbewahrungsbezeichnungen müssen nicht in einer Aufbewahrungsbezeichnungsrichtlinie veröffentlicht werden, um mit dieser Methode angewendet zu werden.

Wenn eine Aufbewahrungsbezeichnung auf einen Ordner angewendet wird, werden alle Elemente im Ordner mit der gleichen Aufbewahrungsbezeichnung gekennzeichnet. Informationen zur Konfliktlösung für Aufbewahrungsbezeichnungen finden Sie unter Wird eine vorhandene Bezeichnung überschrieben oder entfernt. Informationen zu Aufbewahrungsbezeichnungen aus Der Perspektive eines Administrators finden Sie unter Verwenden von Aufbewahrungsbezeichnungen zum Verwalten des Lebenszyklus von in SharePoint gespeicherten Dokumenten.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Globaler Dienst US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) Files.Read.All Files.ReadWrite.All, Sites.ReadWrite.All
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Anwendung Files.Read.All Files.ReadWrite.All, Sites.ReadWrite.All

Anmerkung:Sites.FullControl.All ist die Berechtigung mit den geringsten Berechtigungen, die zum Ändern von Aufbewahrungsbezeichnungen erforderlich ist, die den Inhalt als Datensätze klassifizieren.

HTTP-Anforderung

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

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext ein JSON-Objekt mit dem folgenden Parameter an.

Eigenschaft Typ Beschreibung
name Zeichenfolge Gibt den Namen der Aufbewahrungsbezeichnung an.

Antwort

Wenn eine Datei zum ersten Mal mit einer Aufbewahrungsbezeichnung angewendet wird, gibt diese Methode einen 201 Created Antwortcode und ein aktualisiertes itemRetentionLabel-Objekt im Antworttext zurück. Nachfolgende Updates von retentionLabel geben einen 200 OK Antwortcode zurück.

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

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

Antwort

Das folgende Beispiel zeigt die Antwort.

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"
    }
  }
}