通过

driveItem： setRetentionLabel

命名空间：microsoft.graph

将 (集) 保留标签应用于 driveItem (文件和文件夹) 。 无需在保留标签策略中发布保留标签即可使用此方法应用。

将保留标签应用于文件夹时，文件夹中的所有项目都使用相同的保留标签进行标记。 有关保留标签冲突解决的信息，请参阅 是否重写或删除现有标签。 有关管理员角度的保留标签的信息，请参阅 使用保留标签管理存储在 SharePoint 中的文档的生命周期。

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ✅ ✅ ✅

权限

为此 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