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

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

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

string

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

type

string

例 legal_hold_policy値は常にlegal_hold_policyになります。次の値に固定: legal_hold_policy

assignment_counts

object

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

表示子属性

file

integer(int64)

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

file_version

integer(int64)

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

folder

integer(int64)

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

user

integer(int64)

例 1このポリシーが適用されるユーザーの数。

created_at

string(date-time)

例 2012-12-12T10:53:43-08:00リーガルホールドポリシーオブジェクトが作成された日時。

created_by

ユーザー (Mini)object

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

deleted_at

string(date-time)

例 2012-12-12T10:53:43-08:00ポリシー解除リクエストが送信された日時 (ポリシーが完全に削除されるまでに時間がかかる場合があるため、この日時はポリシーが完全に削除された日時と一致しない場合があります)。nullの場合、ポリシーは削除されていません。

description

string

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

filter_ended_at

string(date-time)

例 2012-12-12T10:53:43-08:00カストディアン割り当てのみに適用されるユーザー指定の日付フィルタ (省略可)。

filter_started_at

string(date-time)

例 2012-12-12T10:53:43-08:00カストディアン割り当てのみに適用されるユーザー指定の日付フィルタ (省略可)。

modified_at

string(date-time)

例 2012-12-12T10:53:43-08:00リーガルホールドポリシーオブジェクトが変更された日時。割り当てが追加または削除されたときには更新されません。

policy_name

string

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

release_notes

string

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

status

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,
    "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"
}