Box Developerドキュメントの新しいベータ版サイトがまもなくリリースされる予定です。最新の開発者向けガイド、APIリファレンス、AI搭載の検索により、Boxを使用した迅速な開発をサポートします。更新情報については今しばらくお待ちください。
リーガルホールドポリシーを作成
新しいリーガルホールドポリシーを作成します。
リクエスト
リクエスト本文
"A custom policy for the sales team"500ポリシーの説明。
"2012-12-18T10:53:43-08:00"500フィルタの終了日。
custodianのリーガルホールド割り当てを使用してこのポリシーが適用されている場合は、日付範囲内に作成またはアップロードされたファイルバージョンのみに適用されます。フォルダやファイルなど、他の割り当てタイプの場合、日付フィルタは無視されます。
is_ongoingがfalseに設定されている場合は必須です。
"2012-12-12T10:53:43-08:00"500フィルタの開始日。
custodianのリーガルホールド割り当てを使用してこのポリシーが適用されている場合は、日付範囲内に作成またはアップロードされたファイルバージョンのみに適用されます。フォルダやファイルなど、他の割り当てタイプの場合、日付フィルタは無視されます。
is_ongoingがfalseに設定されている場合は必須です。
trueこのポリシーに基づく新しい割り当てを初期化後のファイルにも引き続き適用するかどうか。
リーガルホールド割り当てを使用してこのポリシーを適用した場合は、ポリシーの適用後も同じポリシーが新しいファイルバージョンに引き続き適用されます。
たとえば、今日リーガルホールド割り当てをユーザーに適用し、そのユーザーが明日ファイルをアップロードした場合、そのファイルは保持されます。これは、ポリシーが撤回されるまで継続されます。
フィルタ日付が設定されていない場合は必須です。
"Sales Policy"254ポリシーの名前。
レスポンス
新しいリーガルホールドポリシーオブジェクトを返します。
必須のパラメータが指定されていない場合や、is_ongoingもフィルタの日付も指定されていない場合は、エラーを返します。
この名前のポリシーがすでに存在する場合は、エラーを返します。
予期しないクライアントエラー。
リクエストの例
curl -i -X POST "https://api.box.com/2.0/legal_hold_policies" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"policy_name": "Policy 3",
"description": "Automatic created policy"
}'await client.legalHoldPolicies.createLegalHoldPolicy({
policyName: legalHoldPolicyName,
description: legalHoldDescription,
isOngoing: false,
filterStartedAt: filterStartedAt,
filterEndedAt: filterEndedAt,
} satisfies CreateLegalHoldPolicyRequestBody);client.legal_hold_policies.create_legal_hold_policy(
legal_hold_policy_name,
description=legal_hold_description,
filter_started_at=filter_started_at,
filter_ended_at=filter_ended_at,
is_ongoing=False,
)await client.LegalHoldPolicies.CreateLegalHoldPolicyAsync(requestBody: new CreateLegalHoldPolicyRequestBody(policyName: legalHoldPolicyName) { Description = legalHoldDescription, IsOngoing = false, FilterStartedAt = filterStartedAt, FilterEndedAt = filterEndedAt });try await client.legalHoldPolicies.createLegalHoldPolicy(requestBody: CreateLegalHoldPolicyRequestBody(policyName: legalHoldPolicyName, description: legalHoldDescription, isOngoing: false, filterStartedAt: filterStartedAt, filterEndedAt: filterEndedAt))client.getLegalHoldPolicies().createLegalHoldPolicy(new CreateLegalHoldPolicyRequestBody.Builder(legalHoldPolicyName).description(legalHoldDescription).filterStartedAt(filterStartedAt).filterEndedAt(filterEndedAt).isOngoing(false).build())await client.LegalHoldPolicies.CreateLegalHoldPolicyAsync(requestBody: new CreateLegalHoldPolicyRequestBody(policyName: legalHoldPolicyName) { Description = legalHoldDescription, IsOngoing = false, FilterStartedAt = filterStartedAt, FilterEndedAt = filterEndedAt });await client.legalHoldPolicies.createLegalHoldPolicy({
policyName: legalHoldPolicyName,
description: legalHoldDescription,
isOngoing: false,
filterStartedAt: filterStartedAt,
filterEndedAt: filterEndedAt,
} satisfies CreateLegalHoldPolicyRequestBody);レスポンスの例
{
"id": "11446498",
"type": "legal_hold_policy",
"assignment_counts": {
"file": 3,
"file_version": 4,
"folder": 2,
"user": 1
},
"created_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"deleted_at": "2012-12-12T10:53:43-08:00",
"description": "Postman created policy",
"filter_ended_at": "2012-12-12T10:53:43-08:00",
"filter_started_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00",
"policy_name": "Policy 4",
"release_notes": "Example",
"status": "active"
}