driveItem: setRetentionLabel

名前空間: microsoft.graph

driveItem (ファイルとフォルダー) に保持ラベルを適用 (設定) します。 保持ラベルは、このメソッドを使用して適用するために保持ラベル ポリシーで発行する必要はありません。

保持ラベルをフォルダーに適用すると、フォルダー内のすべてのアイテムに同じ保持ラベルが付けられます。 保持ラベルの競合解決の詳細については、「 既存のラベルをオーバーライドまたは削除する」を参照してください。 管理者の観点からの保持ラベルの詳細については、「 保持ラベルを使用して SharePoint に格納されているドキュメントのライフサイクルを管理する」を参照してください。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) Files.Read.All Files.ReadWrite.All、Sites.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション Files.Read.All Files.ReadWrite.All、Sites.ReadWrite.All

注:

Sites.FullControl.All は、コンテンツをレコードとして分類する保持ラベルを変更するために必要な最小限の特権アクセス許可です。

注:

SharePoint Embedded には、コンテナーのコンテンツにアクセスするための FileStorageContainer.Selected アクセス許可が必要です。 このアクセス許可は、前に説明した権限とは異なります。 Microsoft Graph のアクセス許可に加えて、アプリには、この API を呼び出すために必要な コンテナーの種類のアクセス許可 が必要です。 詳細については、「 SharePoint Embedded の認証と承認」を参照してください。

HTTP 要求

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

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文で、次のパラメーターを持つ JSON オブジェクトを指定します。

プロパティ 型 説明
name String 保持ラベルの名前を指定します。

応答

保持ラベルを持つファイルを初めて適用すると、このメソッドは応答コード 201 Created と、応答本文で更新された itemRetentionLabel オブジェクトを返します。 retentionLabel に対する後続の更新では、200 OK応答コードが返されます。

例

要求

次の例は要求を示しています。

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

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

応答

次の例は応答を示しています。

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