创建 retentionLabel

命名空间:microsoft.graph.security

创建新的 retentionLabel 对象。

若要创建 处置评审阶段,请在请求正文中包含 actionAfterRetentionPeriod 属性,其中包含指定的可能值之一。

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

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

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) RecordsManagement.ReadWrite.All 不可用。
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 不支持。 不支持。

HTTP 请求

POST /security/labels/retentionLabels

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权
Content-Type application/json. 必需。

请求正文

在请求正文中,提供 retentionLabel 对象的 JSON 表示形式。

创建 retentionLabel 时指定以下属性。

属性 类型 说明
actionAfterRetentionPeriod microsoft.graph.security.actionAfterRetentionPeriod 指定要在保留期内应用此标签的文档执行的操作。 可能的值包括 nonedeletestartDispositionReviewunknownFutureValue
behaviorDuringRetentionPeriod microsoft.graph.security.behaviorDuringRetentionPeriod 指定具有此标签的文档在保留期内的行为方式。 可能的值包括 doNotRetainretainretainAsRecordretainAsRegulatoryRecordunknownFutureValue
descriptionForAdmins String 为管理员提供标签信息。可选。
descriptionForUsers String 为用户提供标签信息。 可选。
displayName String 定义标签名称的唯一字符串。
dispositionReviewStages microsoft.graph.security.dispositionReviewStage 集合 审阅阶段,在此期间,将通知审阅者以确定是必须删除还是保留文档。
retentionDuration microsoft.graph.security.retentionDuration 指定保留内容的天数。
retentionTrigger microsoft.graph.security.retentionTrigger 指定是从内容创建日期、标记日期还是上次修改日期计算保留持续时间。 可能的值包括 dateLabeleddateCreateddateModifieddateOfEventunknownFutureValue
defaultRecordBehavior microsoft.graph.security.defaultRecordBehavior 指定记录标签在创建时处于锁定或解锁状态。 可能的值包括 startLockedstartUnlockedunknownFutureValue
labelToBeApplied String 指定要在当前标签的保留期结束后自动应用的替换标签。

响应

如果成功,此方法在 201 Created 响应正文中返回响应代码和 microsoft.graph.security.retentionLabel 对象。

示例

请求

下面是请求的示例。

POST https://graph.microsoft.com/v1.0/security/labels/retentionLabels
Content-Type: application/json
Content-length: 555

{
  "@odata.type": "#microsoft.graph.security.retentionLabel",
  "displayName": "Retention Schedule 10005",
  "behaviorDuringRetentionPeriod": "retain",
  "actionAfterRetentionPeriod": "startDispositionReview",
  "retentionTrigger": "dateOfEvent",
  "retentionEventType@odata.bind": "https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes('e095f4fc-b966-4c40-94de-fb8a383658e4')",
  "retentionDuration": {
    "@odata.type": "microsoft.graph.security.retentionDurationInDays",
    "days": 2555
  },
   "dispositionReviewStages": [
    {
      "stageNumber" : 1,
      "name": "Stage1",
      "reviewersEmailAddresses ": [
        "Admin@contoso.onmicrosoft.com"
      ]
    }
  ],
  "descriptionForAdmins": "retain for 7 years",
  "descriptionForUsers": "retain for 7 years",
  "descriptors": {
    "authorityTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/authorities('fie3f4fc-b966-4c40-94de-fb8a383658e4')",
    "categoryTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/categories('0bjk8-b966-4c40-94de-fb8a383658e4')",
    "citationTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/citations('0e23f4fc-b966-4c40-94de-fb8a383658e4')",
    "departmentTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/departments('p99ef4fc-b966-4c40-94de-fb8a383658e4')",
    "filePlanReferenceTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/filePlanReferences('e095f4fc-b966-4c40-94de-fb8a383658e4')"
  },
  "defaultRecordBehavior":"startLocked",
}

响应

以下是响应示例。

注意:为了提高可读性,可能缩短了此处显示的响应对象。

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.security.retentionLabel",
  "id": "64a99fb4-07be-0481-8746-44c15c0eef1f",
  "displayName": "Retention Schedule 10005",
  "behaviorDuringRetentionPeriod": "retain",
  "actionAfterRetentionPeriod": "startDispositionReview",
  "retentionTrigger": "dateOfEvent",
  "retentionDuration": {
    "@odata.type": "microsoft.graph.security.retentionDurationInDays",
    "days": 2555
  },
  "dispositionReviewStages": [
    {
     "stageNumber" : 1,
      "name": "Stage1",
      "reviewersEmailAddresses ": [
        "Admin@contoso.onmicrosoft.com"
      ]
    }
  ],
  "isInUse": true,
  "descriptionForAdmins": "retain for 7 years",
  "descriptionForUsers": "retain for 7 years",
  "defaultRecordBehavior":"startLocked",
  "createdBy": {
   "user": {
      "id": "9563a605-e827-4324-a5a9-09efddff1e90",
      "displayName": "Admin"
    }
  },
  "createdDateTime": "2021-08-23T16:43:55Z",
  "labelToBeApplied": " ",
  "defaultRecordBehavior": "startLocked",
  "descriptors": {
    "authority": {
      "displayName": "Business"
    },
    "category": {
      "displayName": "Accounts Payable",
    },
    "citation": {
      "displayName" : "Contoso Company Policy",
      "citationUrl": "www.citationUrl.com",
      "citationJurisdiction": "Contoso"
    },
    "department": {
      "displayName" : "Finance"
    },
    "filePlanReference": {
      "displayName" : "FIN 01-02-001"
    }
  }
}