Создание retentionLabel

  • Статья

Пространство имен: microsoft.graph.security

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Создайте объект retentionLabel .

Чтобы создать этап проверки ликвидации, добавьте свойство actionAfterRetentionPeriod в текст запроса с одним из указанных возможных значений.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet
✅ ✅ ✅ ❌

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) RecordsManagement.ReadWrite.All Недоступно.
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Для приложений Не поддерживается. Не поддерживается.

HTTP-запрос

POST /security/labels/retentionLabels

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type application/json. Обязательно.

Текст запроса

В тексте запроса укажите представление объекта retentionLabel в формате JSON.

Укажите следующие свойства при создании retentionLabel.

Свойство Тип Описание
actionAfterRetentionPeriod microsoft.graph.security.actionAfterRetentionPeriod Указывает действие, выполняемое с документом с этой меткой в течение периода хранения. Допустимые значения: none, delete, startDispositionReview, unknownFutureValue.
behaviorDuringRetentionPeriod microsoft.graph.security.behaviorDuringRetentionPeriod Указывает поведение документа с этой меткой в течение периода хранения. Допустимые значения: doNotRetain, retain, retainAsRecord, retainAsRegulatoryRecord, unknownFutureValue.
descriptionForAdmins String Предоставляет сведения о метки для администратора. Необязательный.
descriptionForUsers String Предоставляет сведения о метки для пользователя. Необязательный параметр.
displayName String Уникальная строка, определяющая имя метки.
dispositionReviewStages коллекция microsoft.graph.security.dispositionReviewStage Этапы проверки, на которых рецензенты получают уведомления, чтобы определить, нужно ли удалить или сохранить документ.
retentionDuration microsoft.graph.security.retentionDuration Указывает количество дней хранения содержимого.
retentionTrigger microsoft.graph.security.retentionTrigger Указывает, вычисляется ли длительность хранения с даты создания контента, даты с меткой или даты последнего изменения. Допустимые значения: dateLabeled, dateCreated, dateModified, dateOfEvent, unknownFutureValue.
defaultRecordBehavior microsoft.graph.security.defaultRecordBehavior Указывает заблокированное или разблокированное состояние метки записи при ее создании. Допустимые значения: startLocked, startUnlocked, unknownFutureValue.
labelToBeApplied String Указывает метку замены, применяемую автоматически после окончания срока хранения текущей метки.

Отклик

В случае успешного 201 Created выполнения этот метод возвращает код отклика и объект microsoft.graph.security.retentionLabel в теле отклика.

Примеры

Запрос

Ниже приведен пример запроса.

POST https://graph.microsoft.com/beta/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"
    }
  }
}