リテンションポリシーを取得

このリソースは、バージョン2024.0のエンドポイントで使用されています。詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

retention_policy_id

string

required

リテンションポリシーのID。

Query Parameters

fields

string[]

レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。

このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。

Response

リテンションポリシーオブジェクトを返します。

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

string

required

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

Example:

"12345"

type

enum<string>

required

値は常にretention_policyになります。

利用可能なオプション:

retention_policy

Example:

"retention_policy"

policy_name

string

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

Example:

"Some Policy Name"

retention_length

string<int32>

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

Example:

"365"

disposition_action

enum<string>

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

利用可能なオプション:

permanently_delete,

remove_retention

Example:

"permanently_delete"

description

string

リテンションポリシーのテキストによる追加の説明。

Example:

"Policy to retain all reports for at least one month"

policy_type

enum<string>

リテンションポリシーのタイプ。リテンションポリシーのタイプは、finite (コンテンツを保持する期間が事前にわかっている場合)、またはindefinite (コンテンツを保持する期間が不明な場合) のいずれかになります。

利用可能なオプション:

finite,

indefinite

Example:

"finite"

retention_type

enum<string>

以下のリテンションの種類を指定します。

modifiable: リテンションポリシーを変更できます。たとえば、フォルダの追加と削除、ポリシー期間の短縮と延長、または割り当ての削除を行うことができます。リテンションポリシーが規制目的に関連していない場合はこの種類を使用してください。
non-modifiable: フォルダの追加、期間の延長、ポリシーの撤回、廃棄アクションまたは通知設定の変更という限られた方法でしかリテンションポリシーを変更できません。割り当ての削除やポリシー期間の短縮など、その他の操作は実行できません。規制に関するリテンションポリシーを確実に遵守する場合はこの種類を使用してください。

利用可能なオプション:

modifiable,

non_modifiable

Example:

"non_modifiable"

status

enum<string>

リテンションポリシーのステータス。ポリシーのステータスは、管理者が明示的に撤回しない限り、activeになります (撤回されたポリシーのステータスはretiredになります)。一度廃止したポリシーを再度アクティブにすることはできません。

利用可能なオプション:

active,

retired

Example:

"active"

created_by

ユーザー (Mini) · object

リテンションポリシーを作成したユーザーをMini版のユーザーオブジェクトで表示。

表示子属性

created_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

created_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

created_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。

Example:

"ceo@example.com"

created_at

string<date-time>

リテンションポリシーオブジェクトが作成された日時。

Example:

"2012-12-12T10:53:43-08:00"

modified_at

string<date-time>

リテンションポリシーオブジェクトが最後に変更された日時。

Example:

"2012-12-12T10:53:43-08:00"

can_owner_extend_retention

boolean

元のリテンション期間が終了に近づいたときに、ポリシーが適用されている項目の所有者がリテンションを延長できるかどうかを決定します。

Example:

false

are_owners_notified

boolean

リテンション期間が終了に近づいたときに、ポリシーが適用されている項目の所有者と共同所有者に通知するかどうかを決定します。

Example:

false

custom_notification_recipients

ユーザー (Mini) · object[]

リテンションポリシーの期間が終了に近づいたときに通知されるユーザーのリスト。

表示子属性

custom_notification_recipients.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

custom_notification_recipients.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

custom_notification_recipients.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。

Example:

"ceo@example.com"

assignment_counts

object

項目タイプごとに、リテンションポリシーによる割り当て数をカウントします。

表示子属性

assignment_counts.enterprise

integer<int64>

このポリシーでの企業の割り当て数。最大値は1です。

Example:

1

assignment_counts.folder

integer<int64>

このポリシーでのフォルダの割り当て数。

Example:

1

assignment_counts.metadata_template

integer<int64>

このポリシーでのメタデータテンプレートの割り当て数。

Example:

1