リーガルホールドポリシーを作成

このリソースは、バージョン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.

Body

application/json

policy_name

string

required

ポリシーの名前。

Maximum string length: 254

Example:

"Sales Policy"

description

string

ポリシーの説明。

Maximum string length: 500

Example:

"A custom policy for the sales team"

filter_started_at

string<date-time>

フィルタの開始日。

custodianのリーガルホールド割り当てを使用してこのポリシーが適用されている場合は、日付範囲内に作成またはアップロードされたファイルバージョンのみに適用されます。フォルダやファイルなど、他の割り当てタイプの場合、日付フィルタは無視されます。

is_ongoingがfalseに設定されている場合は必須です。

Maximum string length: 500

Example:

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

filter_ended_at

string<date-time>

フィルタの終了日。

is_ongoingがfalseに設定されている場合は必須です。

Maximum string length: 500

Example:

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

is_ongoing

boolean

このポリシーに基づく新しい割り当てを初期化後のファイルにも引き続き適用するかどうか。

リーガルホールド割り当てを使用してこのポリシーを適用した場合は、ポリシーの適用後も同じポリシーが新しいファイルバージョンに引き続き適用されます。

たとえば、今日リーガルホールド割り当てをユーザーに適用し、そのユーザーが明日ファイルをアップロードした場合、そのファイルは保持されます。これは、ポリシーが撤回されるまで継続されます。

フィルタ日付が設定されていない場合は必須です。

Example:

true

Response

新しいリーガルホールドポリシーオブジェクトを返します。

リーガルホールドポリシー情報には、名前、説明、フィルタ日付など、ポリシーの基本的な特性が記載されています。 Mini版のリーガルホールドポリシー。

string

required

このリーガルホールドポリシーの一意の識別子。

Example:

"11446498"

type

enum<string>

required

値は常にlegal_hold_policyになります。

利用可能なオプション:

legal_hold_policy

Example:

"legal_hold_policy"

policy_name

string

リーガルホールドポリシーの名前。

Maximum string length: 254

Example:

"Policy 4"

description

string

リーガルホールドポリシーの説明。これは省略可能なプロパティで、最大500文字まで入力できます。

Maximum string length: 500

Example:

"Postman created policy"

status

enum<string>

使用可能な値:

「active」 - ポリシーは遷移中の状態ではありません。
「applying」 - ポリシーの適用中です。
「releasing」 - 解除処理を行っています。
「released」 - ポリシーは非アクティブになりました。

利用可能なオプション:

active,

applying,

releasing,

released

Example:

"active"

assignment_counts

object

このリーガルホールド内の項目タイプごとの割り当て数。

表示子属性

created_by

ユーザー (Mini) · object

リーガルホールドポリシーオブジェクトを作成したユーザー。

表示子属性

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"

deleted_at

string<date-time>

ポリシー解除リクエストが送信された日時 (ポリシーが完全に削除されるまでに時間がかかる場合があるため、この日時はポリシーが完全に削除された日時と一致しない場合があります)。

nullの場合、ポリシーは削除されていません。

Example:

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

filter_started_at

string<date-time>

カストディアン割り当てのみに適用されるユーザー指定の日付フィルタ (省略可)。

Example:

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

filter_ended_at

string<date-time>

カストディアン割り当てのみに適用されるユーザー指定の日付フィルタ (省略可)。

Example:

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

release_notes

string

ポリシーが作成された理由に関するメモ (省略可)。

Maximum string length: 500

Example:

"Example"