リテンションポリシー
リテンションポリシーは、指定した期間にわたってコンテンツが完全に削除されるのを防止します。管理者はリテンションポリシーを作成して特定のフォルダ、メタデータテンプレート、または企業全体に割り当てることができます。この機能を使用するには、アプリケーション管理コンソールから、APIキーに対して [リテンションポリシーを管理する] スコープを有効にする必要があります。
12345リテンションポリシーを表す一意の識別子。
retention_policyretention_policy
次の値に固定: retention_policy
falseリテンション期間が終了に近づいたときに、ポリシーが適用されている項目の所有者と共同所有者に通知するかどうかを決定します。
項目タイプごとに、リテンションポリシーによる割り当て数をカウントします。
1このポリシーでの企業の割り当て数。最大値は1です。
1このポリシーでのフォルダの割り当て数。
1このポリシーでのメタデータテンプレートの割り当て数。
false元のリテンション期間が終了に近づいたときに、ポリシーが適用されている項目の所有者がリテンションを延長できるかどうかを決定します。
2012-12-12T10:53:43-08:00リテンションポリシーオブジェクトが作成された日時。
リテンションポリシーを作成したユーザーをMini版のユーザーオブジェクトで表示。
リテンションポリシーの期間が終了に近づいたときに通知されるユーザーのリスト。
Policy to retain all reports for at least one monthリテンションポリシーのテキストによる追加の説明。
permanently_deleteリテンションポリシーの廃棄アクション。このアクションをpermanently_deleteに設定すると、ポリシーによって保持されているコンテンツが完全に削除されます。remove_retentionに設定すると、コンテンツへのリテンションポリシーの適用が解除され、リテンションポリシーの有効期限が切れた後は、ユーザーがコンテンツを削除できるようになります。
次の値のいずれか1つ: permanently_delete,remove_retention
2012-12-12T10:53:43-08:00リテンションポリシーオブジェクトが最後に変更された日時。
Some Policy Nameリテンションポリシーの名前。
finiteリテンションポリシーのタイプ。リテンションポリシーのタイプは、finite (コンテンツを保持する期間が事前にわかっている場合)、またはindefinite (コンテンツを保持する期間が不明な場合) のいずれかになります。
次の値のいずれか1つ: finite,indefinite
3651リテンションポリシーの期間。この値はリテンションポリシーがコンテンツに割り当てられた後、有効である日数を示します。ポリシーのpolicy_typeがindefiniteである場合は、retention_lengthもindefiniteになります。
non_modifiable以下のリテンションの種類を指定します。
-
modifiable: リテンションポリシーを変更できます。たとえば、フォルダの追加と削除、ポリシー期間の短縮と延長、または割り当ての削除を行うことができます。リテンションポリシーが規制目的に関連していない場合はこの種類を使用してください。 -
non-modifiable: フォルダの追加、期間の延 長、ポリシーの撤回、廃棄アクションまたは通知設定の変更という限られた方法でしかリテンションポリシーを変更できません。割り当ての削除やポリシー期間の短縮など、その他の操作は実行できません。規制に関するリテンションポリシーを確実に遵守する場合はこの種類を使用してください。
次の値のいずれか1つ: modifiable,non_modifiable
activeリテンションポリシーのステータス。ポリシーのステータスは、管理者が明示的に撤回しない限り、activeになります (撤回されたポリシーのステータスはretiredになります)。一度廃止したポリシーを再度アクティブにすることはできません。
次の値のいずれか1つ: active,retired
レスポンスの例
{
"id": "12345",
"type": "retention_policy",
"are_owners_notified": false,
"assignment_counts": {
"enterprise": 1,
"folder": 1,
"metadata_template": 1
},
"can_owner_extend_retention": false,
"created_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"custom_notification_recipients": [
{
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
}
],
"description": "Policy to retain all reports for at least one month",
"disposition_action": "permanently_delete",
"modified_at": "2012-12-12T10:53:43-08:00",
"policy_name": "Some Policy Name",
"policy_type": "finite",
"retention_length": "365",
"retention_type": "non_modifiable",
"status": "active"
}