Box Developerドキュメント
ログイン

リーガルホールドポリシー

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

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

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

通常、Standardバリアントに含まれるフィールドは、固有のAPIエンドポイントを介してこのリソースがリクエストされたときに返されます。 たとえば、fieldsパラメータが指定されていない場合、IDでファイルを取得すると、これらのフィールドが返されます。

string
11446498

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

string
legal_hold_policy

値は常にlegal_hold_policyになります。

次の値に固定: legal_hold_policy

object

Counts of assignments within a legal hold policy by item type.

integer (int64)
3

このポリシーが適用されるファイルの数。

integer (int64)
4

このポリシーが適用されるファイルバージョンの数。

integer (int64)
2

このポリシーが適用されるフォルダの数。

integer (int64)
6

The number of users this policy is applied to with the interactions type assignment.

integer (int64)
5

The number of users this policy is applied to with the ownership type assignment.

integer (int64)
1

The number of users this policy is applied to with the access type assignment.

string (date-time)
2012-12-12T10:53:43-08:00

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

ユーザー (Mini) object

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

string (date-time)
2012-12-12T10:53:43-08:00

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

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

string
Postman created policy
500

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

string (date-time)
2012-12-12T10:53:43-08:00

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

string (date-time)
2012-12-12T10:53:43-08:00

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

string (date-time)
2012-12-12T10:53:43-08:00

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

string
Policy 4
254

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

string
Example
500

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

string
active

使用可能な値:

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

次の値のいずれか1つ: active,applying,releasing,released

レスポンスの例

{
  "id": "11446498",
  "type": "legal_hold_policy",
  "assignment_counts": {
    "file": 3,
    "file_version": 4,
    "folder": 2,
    "interactions": 6,
    "ownership": 5,
    "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"
}