メインコンテンツへスキップ
PUT
/
legal_hold_policies
/
{legal_hold_policy_id}
cURL
curl -i -X PUT "https://api.box.com/2.0/legal_hold_policies/324432" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "policy_name": "Policy 4"
     }'
{
  "id": "11446498",
  "type": "legal_hold_policy",
  "policy_name": "Policy 4",
  "description": "Postman created policy",
  "status": "active",
  "assignment_counts": {
    "user": 1,
    "folder": 2,
    "file": 3,
    "file_version": 4,
    "ownership": 5,
    "interactions": 6
  },
  "created_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "deleted_at": "2012-12-12T10:53:43-08:00",
  "filter_started_at": "2012-12-12T10:53:43-08:00",
  "filter_ended_at": "2012-12-12T10:53:43-08:00",
  "release_notes": "Example"
}

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

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

承認

​
Authorization
string
header
必須

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

パスパラメータ

​
legal_hold_policy_id
string
必須

リーガルホールドポリシーのID。

ボディ

application/json
​
policy_name
string

ポリシーの名前。

Maximum string length: 254
例:

"Sales Policy"

​
description
string

ポリシーの説明。

Maximum string length: 500
例:

"A custom policy for the sales team"

​
release_notes
string

ポリシーが解除された理由に関するメモ。

Maximum string length: 500
例:

"Required for GDPR"

レスポンス

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

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

​
id
string
必須

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

例:

"11446498"

​
type
enum<string>
必須

値は常にlegal_hold_policyになります。

利用可能なオプション:
legal_hold_policy
例:

"legal_hold_policy"

​
policy_name
string

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

Maximum string length: 254
例:

"Policy 4"

​
description
string

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

Maximum string length: 500
例:

"Postman created policy"

​
status
enum<string>

使用可能な値:

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

"active"

​
assignment_counts
object

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

​
created_by
ユーザー (Mini) · object

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

​
created_at
string<date-time>

リーガルホールドポリシーオブジェクトが作成された日時。

例:

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

​
modified_at
string<date-time>

リーガルホールドポリシーオブジェクトが変更された日時。割り当てが追加または削除されたときには更新されません。

例:

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

​
deleted_at
string<date-time>

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

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

例:

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

​
filter_started_at
string<date-time>

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

例:

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

​
filter_ended_at
string<date-time>

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

例:

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

​
release_notes
string

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

Maximum string length: 500
例:

"Example"