リテンションポリシーリソース

リテンションポリシーは、指定した期間にわたってコンテンツが完全に削除されるのを防止します。管理者はリテンションポリシーを作成して特定のフォルダや企業全体に割り当てることができます。

リテンションポリシー

リテンションポリシーのリスト。

属性と例

プロパティ	型	必須	説明
`entries`	array of リテンションポリシー	いいえ	各エントリがリテンションポリシーオブジェクトを表しているリスト。
`limit`	`integer`	いいえ	これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。
`next_marker`	`string`	いいえ	次の検索結果ページの開始場所のマーカー。 `null` を指定できます。

例

{
  "entries": [
    {
      "id": "12345",
      "type": "retention_policy",
      "policy_name": "Some Policy Name",
      "retention_length": "365",
      "disposition_action": "permanently_delete",
      "max_extension_length": "365",
      "description": "Policy to retain all reports for at least one month",
      "policy_type": "finite",
      "retention_type": "non_modifiable",
      "status": "active",
      "created_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "can_owner_extend_retention": false,
      "are_owners_notified": false,
      "custom_notification_recipients": [
        {
          "id": "11446498",
          "type": "user",
          "name": "Aaron Levie",
          "login": "ceo@example.com"
        }
      ],
      "assignment_counts": {
        "enterprise": 1,
        "folder": 1,
        "metadata_template": 1
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}

リテンションポリシー

リテンションポリシーは、指定した期間にわたってコンテンツが完全に削除されるのを防止します。管理者はリテンションポリシーを作成して特定のフォルダ、メタデータテンプレート、または企業全体に割り当てることができます。この機能を使用するには、アプリケーション管理コンソールから、APIキーに対して [リテンションポリシーを管理する] スコープを有効にする必要があります。

属性と例

プロパティ	型	必須	説明
`id`	`string`	はい	リテンションポリシーを表す一意の識別子。
`type`	`enum<string>`	はい	値は常に`retention_policy`になります。使用可能なオプション: `retention_policy`.
`policy_name`	`string`	いいえ	リテンションポリシーの名前。
`retention_length`	`string`	いいえ	リテンションポリシーの期間。この値はリテンションポリシーがコンテンツに割り当てられた後、有効である日数を示します。ポリシーの`policy_type`が`indefinite`である場合は、`retention_length`も`indefinite`になります。
`disposition_action`	`enum<string>`	いいえ	リテンションポリシーの廃棄アクション。このアクションを`permanently_delete`に設定すると、ポリシーによって保持されているコンテンツが完全に削除されます。`remove_retention`に設定すると、コンテンツへのリテンションポリシーの適用が解除され、リテンションポリシーの有効期限が切れた後は、ユーザーがコンテンツを削除できるようになります。使用可能なオプション: `permanently_delete`, `remove_retention`.
`max_extension_length`	`リテンションポリシーの延長期間の上限 (レスポンス)`	いいえ	使用可能なオプション: `none`.
`description`	`string`	いいえ	リテンションポリシーのテキストによる追加の説明。
`policy_type`	`enum<string>`	いいえ	リテンションポリシーのタイプ。リテンションポリシーのタイプは、`finite` (コンテンツを保持する期間が事前にわかっている場合)、または`indefinite` (コンテンツを保持する期間が不明な場合) のいずれかになります。使用可能なオプション: `finite`, `indefinite`.
`retention_type`	`enum<string>`	いいえ	以下のリテンションの種類を指定します。 - `modifiable`: リテンションポリシーを変更できます。たとえば、フォルダの追加と削除、ポリシー期間の短縮と延長、または割り当ての削除を行うことができます。リテンションポリシーが規制目的に関連していない場合はこの種類を使用してください。 - `non-modifiable`: フォルダの追加、期間の延長、ポリシーの撤回、廃棄アクションまたは通知設定の変更という限られた方法でしかリテンションポリシーを変更できません。割り当ての削除やポリシー期間の短縮など、その他の操作は実行できません。規制に関するリテンションポリシーを確実に遵守する場合はこの種類を使用してください。使用可能なオプション: `modifiable`, `non_modifiable`.
`status`	`enum<string>`	いいえ	リテンションポリシーのステータス。ポリシーのステータスは、管理者が明示的に撤回しない限り、`active`になります (撤回されたポリシーのステータスは`retired`になります)。一度廃止したポリシーを再度アクティブにすることはできません。使用可能なオプション: `active`, `retired`.
`created_by`	ユーザー (Mini)	いいえ	リテンションポリシーを作成したユーザーをMini版のユーザーオブジェクトで表示。
`created_at`	`string`	いいえ	リテンションポリシーオブジェクトが作成された日時。
`modified_at`	`string`	いいえ	リテンションポリシーオブジェクトが最後に変更された日時。
`can_owner_extend_retention`	`boolean`	いいえ	元のリテンション期間が終了に近づいたときに、ポリシーが適用されている項目の所有者がリテンションを延長できるかどうかを決定します。
`are_owners_notified`	`boolean`	いいえ	リテンション期間が終了に近づいたときに、ポリシーが適用されている項目の所有者と共同所有者に通知するかどうかを決定します。
`custom_notification_recipients`	array of ユーザー (Mini)	いいえ	リテンションポリシーの期間が終了に近づいたときに通知されるユーザーのリスト。
`assignment_counts`	`object`	いいえ	項目タイプごとに、リテンションポリシーによる割り当て数をカウントします。

例

{
  "id": "12345",
  "type": "retention_policy",
  "policy_name": "Some Policy Name",
  "retention_length": "365",
  "disposition_action": "permanently_delete",
  "max_extension_length": "365",
  "description": "Policy to retain all reports for at least one month",
  "policy_type": "finite",
  "retention_type": "non_modifiable",
  "status": "active",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "can_owner_extend_retention": false,
  "are_owners_notified": false,
  "custom_notification_recipients": [
    {
      "id": "11446498",
      "type": "user",
      "name": "Aaron Levie",
      "login": "ceo@example.com"
    }
  ],
  "assignment_counts": {
    "enterprise": 1,
    "folder": 1,
    "metadata_template": 1
  }
}

リテンションポリシー (Base)

リテンションポリシーのBase版の表示。

属性と例

プロパティ	型	必須	説明
`id`	`string`	はい	リテンションポリシーを表す一意の識別子。
`type`	`enum<string>`	はい	値は常に`retention_policy`になります。使用可能なオプション: `retention_policy`.

例

{
  "id": "12345",
  "type": "retention_policy"
}

リテンションポリシー (Mini)

他のリソース内にネストされたときに使用されるリテンションポリシーのMini版の表示。

属性と例

プロパティ	型	必須	説明
`id`	`string`	はい	リテンションポリシーを表す一意の識別子。
`type`	`enum<string>`	はい	値は常に`retention_policy`になります。使用可能なオプション: `retention_policy`.
`policy_name`	`string`	いいえ	リテンションポリシーの名前。
`retention_length`	`string`	いいえ	リテンションポリシーの期間。この値はリテンションポリシーがコンテンツに割り当てられた後、有効である日数を示します。ポリシーの`policy_type`が`indefinite`である場合は、`retention_length`も`indefinite`になります。
`disposition_action`	`enum<string>`	いいえ	リテンションポリシーの廃棄アクション。このアクションを`permanently_delete`に設定すると、ポリシーによって保持されているコンテンツが完全に削除されます。`remove_retention`に設定すると、コンテンツへのリテンションポリシーの適用が解除され、リテンションポリシーの有効期限が切れた後は、ユーザーがコンテンツを削除できるようになります。使用可能なオプション: `permanently_delete`, `remove_retention`.
`max_extension_length`	`リテンションポリシーの延長期間の上限 (レスポンス)`	いいえ	使用可能なオプション: `none`.

例

{
  "id": "12345",
  "type": "retention_policy",
  "policy_name": "Some Policy Name",
  "retention_length": "365",
  "disposition_action": "permanently_delete",
  "max_extension_length": "365"
}

​リテンションポリシー

​リテンションポリシー

​リテンションポリシー (Base)

​リテンションポリシー (Mini)

リテンションポリシー

リテンションポリシー

リテンションポリシー (Base)

リテンションポリシー (Mini)