リーガルホールドポリシーを割り当て

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

string

required

割り当てるポリシーのID。

Example:

"123244"

assign_to

object

required

ポリシーを割り当てる項目。

表示子属性

assign_to.type

enum<string>

required

ポリシーを割り当てる項目のタイプ。

利用可能なオプション:

file,

file_version,

folder,

user,

ownership,

interaction

Example:

"folder"

assign_to.id

string

required

ポリシーを割り当てる項目のID。

Example:

"6564564"

Response

新しいリーガルホールドポリシー割り当てを返します。

リーガルホールド割り当ては、ユーザー、フォルダ、ファイル、またはファイルバージョンにリーガルホールドポリシーを割り当てる目的に使用されます。

リーガルホールド割り当てを作成すると、その割り当ての「apply-to」エンティティに属するファイルバージョンにホールドが適用されます。リーガルホールド割り当ては、ユーザー、フォルダ、ファイル、またはファイルバージョンにリーガルホールドポリシーを割り当てる目的に使用されます。

リーガルホールド割り当てを作成すると、その割り当ての「apply-to」エンティティに属するファイルバージョンにホールドが適用されます。

string

このリーガルホールド割り当ての一意の識別子。

Example:

"11446498"

type

enum<string>

値は常にlegal_hold_policy_assignmentになります。

利用可能なオプション:

legal_hold_policy_assignment

Example:

"legal_hold_policy_assignment"

legal_hold_policy

リーガルホールドポリシー (Mini) · object

そのリーガルホールドポリシー割り当てを含むポリシー。

表示子属性

legal_hold_policy.id

string

required

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

Example:

"11446498"

legal_hold_policy.type

enum<string>

required

値は常にlegal_hold_policyになります。

利用可能なオプション:

legal_hold_policy

Example:

"legal_hold_policy"

assigned_to

リーガルホールドポリシーの項目 · object

リーガルホールドポリシーが割り当てられている項目。タイプとIDを含みます。

リーガルホールドポリシーの項目
リーガルホールドポリシーの項目
リーガルホールドポリシーの項目

表示子属性

assigned_to.id

string

required

ファイルを表す一意の識別子。

ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123の場合、file_idは123です。

Example:

"12345"

assigned_to.type

enum<string>

required

値は常にfileになります。

利用可能なオプション:

file

Example:

"file"

assigned_to.etag

string | null

このファイルのHTTP etag。これは変更が発生した場合 (またはしなかった場合) にファイルに対して変更を行う目的でのみ、If-MatchおよびIf-None-Matchヘッダー内の一部のAPIエンドポイントで使用できます。

Example:

"1"

assigned_to.sequence_id

string | null

この項目に適用された最新のUser Eventを表す数値の識別子。

これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。

たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventのsequence_idが最初に取得されたリソースのsequence_idよりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。

Example:

"3"

assigned_to.name

string

ファイルの名前。

Example:

"Contract.pdf"

assigned_to.sha1

string<digest>

ファイルのSHA1ハッシュ。Box上のファイルとローカルファイルの内容を比較する目的に使用できます。

Example:

"85136C79CBF9FE36BB9D05D0639C70C265C18D37"

assigned_to.file_version

ファイルバージョン (Mini) · object

ファイルの現在のバージョンに関する情報。

表示子属性

assigned_to.file_version.id

string

required

ファイルバージョンを表す一意の識別子。

Example:

"12345"

assigned_to.file_version.type

enum<string>

required

値は常にfile_versionになります。

利用可能なオプション:

file_version

Example:

"file_version"

assigned_to.file_version.sha1

string

ファイルの現在のバージョンのSHA1ハッシュ。

Example:

"134b65991ed521fcfe4724b7d814ab8ded5185dc"

assigned_to.description

string

このファイルの説明 (省略可)。説明が255文字を超える場合は、最初の255文字がファイルの説明として設定され、残りは無視されます。

Maximum string length: 255

Example:

"Contract for Q1 renewal"

assigned_to.size

integer

ファイルサイズ (バイト単位)。この整数を解析する際には、非常に大きな数値となって整数オーバーフローになる可能性があるため、注意が必要です。

Example:

629644

assigned_to.path_collection

パスのコレクション · object

ルートフォルダを起点にした、このファイルを含むフォルダツリー。

表示子属性

assigned_to.path_collection.total_count

integer<int64>

required

このリスト内のフォルダの数。

Example:

1

assigned_to.path_collection.entries

フォルダ (Mini) · object[]

required

この項目の親フォルダ。

表示子属性

assigned_to.path_collection.entries.id

string

required

フォルダを表す一意の識別子。

フォルダIDを確認するには、ウェブアプリケーションでフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folders/123の場合、folder_idは123です。

Example:

"12345"

assigned_to.path_collection.entries.type

enum<string>

required

値は常にfolderになります。

利用可能なオプション:

folder

Example:

"folder"

assigned_to.path_collection.entries.etag

string | null

このフォルダのHTTP etag。これは変更が発生した場合 (またはしなかった場合) にフォルダに対して変更を行う目的でのみ、If-MatchおよびIf-None-Matchヘッダー内の一部のAPIエンドポイントで使用できます。

Example:

"1"

assigned_to.path_collection.entries.sequence_id

string | null

この項目に適用された最新のUser Eventを表す数値の識別子。

これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。

Example:

"3"

assigned_to.path_collection.entries.name

string

フォルダの名前。

Example:

"Contracts"

assigned_to.created_at

string<date-time>

Box上でこのファイルが作成された日時。

Example:

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

assigned_to.modified_at

string<date-time>

Boxでこのファイルが最後に更新された日時。

Example:

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

assigned_to.trashed_at

string<date-time> | null

このファイルがごみ箱に移動された日時。

Example:

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

assigned_to.purged_at

string<date-time> | null

このファイルがごみ箱から削除される予定日時。

Example:

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

assigned_to.content_created_at

string<date-time> | null

このファイルが最初に作成された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。

Example:

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

assigned_to.content_modified_at

string<date-time> | null

このファイルが最後に更新された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。

Example:

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

assigned_to.created_by

ユーザー (Mini) · object

このファイルを作成したユーザー。

表示子属性

assigned_to.created_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

assigned_to.created_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

assigned_to.created_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。

Example:

"ceo@example.com"

assigned_to.modified_by

ユーザー (Mini) · object

このファイルを最後に変更したユーザー。

表示子属性

assigned_to.modified_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

assigned_to.modified_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

assigned_to.modified_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。

Example:

"ceo@example.com"

assigned_to.owned_by

ユーザー (Mini) · object

このファイルを所有するユーザー。

表示子属性

assigned_to.owned_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

assigned_to.owned_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

assigned_to.owned_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。

Example:

"ceo@example.com"

assigned_to.shared_link

共有リンク · object

このファイルの共有リンク。このファイルに対してまだ共有リンクが作成されていない場合、この値はnullになります。

表示子属性

assigned_to.shared_link.url

string<url>

required

Box上の項目にアクセスするために使用できるURL。

このURLに移動すると、BoxのプレビューUIに項目が表示され、許可されている場合は、このUIからファイルをダウンロードできます。

このURLは、この共有リンクに対してカスタムのvanity_urlが設定されている場合でも動作します。

Example:

"https://www.box.com/s/vspke7y05sb214wjokpk"

assigned_to.shared_link.effective_access

enum<string>

required

共有リンクの実際のアクセスレベル。許可されるアクセスレベルが会社の設定で制限されている場合は、accessフィールドの値よりも低いアクセスレベルになることがあります。

利用可能なオプション:

open,

company,

collaborators

Example:

"company"

assigned_to.shared_link.effective_permission

enum<string>

required

この共有リンクの実際の権限。これらにより、共有リンクの権限と、管理者、所有者、任意の先祖項目 (フォルダなど) によって設定される項目の権限の組み合わせの制限が厳しくなります。

利用可能なオプション:

can_edit,

can_download,

can_preview,

no_access

Example:

"can_download"

assigned_to.shared_link.is_password_enabled

boolean

required

共有リンクを通じて項目にアクセスする際にパスワードを要求するかどうかを定義します。

Example:

true

assigned_to.shared_link.download_count

integer

required

この項目がダウンロードされた回数。

Example:

3

assigned_to.shared_link.preview_count

integer

required

この項目がプレビューされた回数。

Example:

3

assigned_to.shared_link.download_url

string<url> | null

ファイルをダウンロードするために使用できるURL。このURLをブラウザで使用すると、ファイルをダウンロードできます。このURLには、ファイルを正しいファイルタイプで保存できるように、ファイル拡張子が含まれます。

フォルダの場合、このプロパティはnullになります。

Example:

"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg"

assigned_to.shared_link.vanity_url

string<url> | null

Boxで項目をプレビューする目的にも使用できる「カスタムURL」。カスタムURLの作成と変更は、Boxウェブアプリケーションでのみ行えます。

Example:

"https://acme.app.box.com/v/my_url/"

assigned_to.shared_link.vanity_name

string | null

vanity_urlフィールドで使用される、共有リンクのカスタム名。

Example:

"my_url"

assigned_to.shared_link.access

enum<string>

この共有リンクのアクセスレベル

open - このリンクを知っている全員にこの項目へのアクセスを許可します
company - 同じ会社のユーザーにのみこの項目へのアクセスを許可します
collaborators - この項目のコラボレータとなっているユーザーに対してのみこの項目へのアクセスを許可します

共有リンクの作成時にこのフィールドを省略した場合は、Enterprise管理者によって指定されたデフォルトのアクセスレベルに設定されます。

利用可能なオプション:

open,

company,

collaborators

Example:

"open"

assigned_to.shared_link.unshared_at

string<date-time> | null

このリンクが共有解除される日時。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。

Example:

"2018-04-13T13:53:23-07:00"

assigned_to.shared_link.permissions

object

このリンクを通じてユーザーが項目のプレビュー、編集、およびダウンロードを行うことを許可するかどうかを定義します。これらの権限は、共有リンクのみに適用され、その項目自体に適用される権限より優先されることはありません。

表示子属性

assigned_to.shared_link.permissions.can_download

boolean

required

共有リンクを通じて項目をダウンロードすることを許可するかどうかを定義します。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。

実際のアクセスレベルがcollaboratorsではなく、openまたはcompanyに設定されている場合は、この値をtrueに設定できます。

Example:

true

assigned_to.shared_link.permissions.can_preview

boolean

required

共有リンクを通じて項目をプレビューすることを許可するかどうかを定義します。

この値は常にtrueです。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。

Example:

true

assigned_to.shared_link.permissions.can_edit

boolean

required

共有リンクからの項目の編集を許可するかどうかを定義します。

can_downloadがtrueで、項目のタイプがfileの場合のみ、この値もtrueに設定できます。

Example:

false

assigned_to.parent

フォルダ (Mini) · object

このフォルダが配置されているフォルダ。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値はnullになる可能性があります。

表示子属性

assigned_to.parent.id

string

required

フォルダを表す一意の識別子。

Example:

"12345"

assigned_to.parent.type

enum<string>

required

値は常にfolderになります。

利用可能なオプション:

folder

Example:

"folder"

assigned_to.parent.etag

string | null

Example:

"1"

assigned_to.parent.sequence_id

string | null

この項目に適用された最新のUser Eventを表す数値の識別子。

これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。

Example:

"3"

assigned_to.parent.name

string

フォルダの名前。

Example:

"Contracts"

assigned_to.item_status

enum<string>

この項目が削除されたかどうかを定義します。

active - 項目がごみ箱に移動されていない場合。
trashed - 項目がごみ箱に移動されているが、まだ削除されていない場合。
deleted - 項目がすでに完全に削除されている場合。

利用可能なオプション:

active,

trashed,

deleted

Example:

"active"

assigned_by

ユーザー (Mini) · object

リーガルホールドポリシー割り当てを作成したユーザー。

表示子属性

assigned_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

assigned_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

assigned_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。

Example:

"ceo@example.com"

assigned_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"