Box Developerドキュメント

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

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

このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。

通常、Miniバリアントに含まれるフィールドは、このリソースが別のリソースのレスポンス内にネストされている場合に返されます。

string
12345

リテンションポリシーを表す一意の識別子。

string
retention_policy

retention_policy

次の値に固定: retention_policy

permanently_delete

リテンションポリシーの廃棄アクション。このアクションをpermanently_deleteに設定すると、ポリシーによって保持されているコンテンツが完全に削除されます。remove_retentionに設定すると、コンテンツへのリテンションポリシーの適用が解除され、リテンションポリシーの有効期限が切れた後は、ユーザーがコンテンツを削除できるようになります。

次の値のいずれか1つ: permanently_delete,remove_retention

Some Policy Name

リテンションポリシーの名前。

string (int32)
365
1

リテンションポリシーの期間。この値はリテンションポリシーがコンテンツに割り当てられた後、有効である日数を示します。ポリシーのpolicy_typeindefiniteである場合は、retention_lengthindefiniteになります。

レスポンスの例

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