ファイルに共有リンクを追加

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

Path Parameters

file_id

string

required

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

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

Query Parameters

fields

string

required

この項目に返されるshared_linkフィールドを明示的にリクエストします。

Body

application/json

shared_link

object

ファイルに作成する共有リンクの設定。共有リンクにデフォルト設定を使用するには、空のオブジェクト ({}) を使用します。

表示子属性

shared_link.access

enum<string>

共有リンクのアクセスレベル。これは、リンクを知っている全員 (open)、会社内のユーザーのみ (company)、ファイルに招待されたユーザーのみ (collaborators) のいずれかに制限できます。

設定しなかった場合、このフィールドは、デフォルトで、企業の管理者が指定したアクセスレベルになります。このデフォルトの設定で共有リンクを作成するには、{ "shared_link": {} }のように、accessフィールドを指定せずにshared_linkオブジェクトを渡します。

companyアクセスレベルは、有料アカウントのみで使用できます。

利用可能なオプション:

open,

company,

collaborators

Example:

"open"

shared_link.password

string | null

共有リンクへのアクセスに必要なパスワード。パスワードをnullに設定するとパスワードが削除されます。今後、パスワードは8文字以上にし、数字、大文字、または英数字以外の文字を含める必要があります。accessがopenに設定されている場合にのみ、パスワードを設定できます。

Example:

"do-n8t-use-this-Password"

shared_link.vanity_name

string

共有リンクのURLで使用するカスタムバニティ名を定義します (例: https://app.box.com/v/my-shared-link)。

バニティURLは通常の共有リンクよりもかなり推測しやすいため、機密性の高いコンテンツを共有する場合は、カスタムURLを使用しないでください。

Minimum string length: 12

Example:

"my-shared-link"

shared_link.unshared_at

string<date-time>

この共有リンクの有効期限が切れる日時のタイムスタンプ。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。この値には、現在の日時より後の日時を指定する必要があります。

Example:

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

shared_link.permissions

object

表示子属性

shared_link.permissions.can_download

boolean

共有リンクからのファイルのダウンロードが許可されているかどうか。accessがopenまたはcompanyに設定されている場合にのみ設定できます。

Example:

true

shared_link.permissions.can_preview

boolean

共有リンクからのファイルのプレビューが許可されているかどうか。この値は常にtrueです。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。

Example:

true

shared_link.permissions.can_edit

boolean

共有リンクからのファイルの編集が許可されているかどうか。accessがopenまたはcompanyに設定されている場合にのみ設定できます。can_downloadがtrueの場合、この値もtrueにしか設定できません。

Example:

true

Response

新しい共有リンクが追加されているファイルのBase版の表示を返します。

任意のファイルAPIエンドポイントからデフォルトで返される可能性があるファイルのFull版の表示。任意のファイルAPIエンドポイントからデフォルトで返されるファイルのStandard版の表示。他のリソースの下にネストされたときに使用されるファイルのMini版の表示。最も基本的なファイルのBase版の表示。fieldsクエリパラメータを使用すると、最小限の数のフィールドが返されます。

string

required

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

Example:

"12345"

type

enum<string>

required

値は常にfileになります。

利用可能なオプション:

file

Example:

"file"

etag

string | null

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

Example:

"1"

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"

name

string

ファイルの名前。

Example:

"Contract.pdf"

sha1

string<digest>

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

Example:

"85136C79CBF9FE36BB9D05D0639C70C265C18D37"

file_version

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

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

表示子属性

file_version.id

string

required

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

Example:

"12345"

file_version.type

enum<string>

required

値は常にfile_versionになります。

利用可能なオプション:

file_version

Example:

"file_version"

file_version.sha1

string

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

Example:

"134b65991ed521fcfe4724b7d814ab8ded5185dc"

description

string

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

Maximum string length: 255

Example:

"Contract for Q1 renewal"

size

integer

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

Example:

629644

path_collection

パスのコレクション · object

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

表示子属性

path_collection.total_count

integer<int64>

required

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

Example:

1

path_collection.entries

フォルダ (Mini) · object[]

required

この項目の親フォルダ。

表示子属性

path_collection.entries.id

string

required

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

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

Example:

"12345"

path_collection.entries.type

enum<string>

required

値は常にfolderになります。

利用可能なオプション:

folder

Example:

"folder"

path_collection.entries.etag

string | null

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

Example:

"1"

path_collection.entries.sequence_id

string | null

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

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

Example:

"3"

path_collection.entries.name

string

フォルダの名前。

Example:

"Contracts"

created_at

string<date-time>

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

Example:

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

modified_at

string<date-time>

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

Example:

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

trashed_at

string<date-time> | null

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

Example:

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

purged_at

string<date-time> | null

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

Example:

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

content_created_at

string<date-time> | null

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

Example:

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

content_modified_at

string<date-time> | null

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

Example:

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

created_by

ユーザー (Mini) · object

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

表示子属性

created_by.id

string

required

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

Example:

"11446498"

created_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

created_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

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

Example:

"ceo@example.com"

modified_by

ユーザー (Mini) · object

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

表示子属性

modified_by.id

string

required

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

Example:

"11446498"

modified_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

modified_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

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

Example:

"ceo@example.com"

owned_by

ユーザー (Mini) · object

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

表示子属性

owned_by.id

string

required

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

Example:

"11446498"

owned_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

owned_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

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

Example:

"ceo@example.com"

shared_link

共有リンク · object

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

表示子属性

shared_link.url

string<url>

required

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

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

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

Example:

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

shared_link.effective_access

enum<string>

required

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

利用可能なオプション:

open,

company,

collaborators

Example:

"company"

shared_link.effective_permission

enum<string>

required

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

利用可能なオプション:

can_edit,

can_download,

can_preview,

no_access

Example:

"can_download"

shared_link.is_password_enabled

boolean

required

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

Example:

true

shared_link.download_count

integer

required

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

Example:

3

shared_link.preview_count

integer

required

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

Example:

3

shared_link.download_url

string<url> | null

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

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

Example:

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

shared_link.vanity_url

string<url> | null

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

Example:

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

shared_link.vanity_name

string | null

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

Example:

"my_url"

shared_link.access

enum<string>

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

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

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

利用可能なオプション:

open,

company,

collaborators

Example:

"open"

shared_link.unshared_at

string<date-time> | null

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

Example:

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

shared_link.permissions

object

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

表示子属性

shared_link.permissions.can_download

boolean

required

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

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

Example:

true

shared_link.permissions.can_preview

boolean

required

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

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

Example:

true

shared_link.permissions.can_edit

boolean

required

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

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

Example:

false

parent

フォルダ (Mini) · object

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

表示子属性

parent.id

string

required

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

Example:

"12345"

parent.type

enum<string>

required

値は常にfolderになります。

利用可能なオプション:

folder

Example:

"folder"

parent.etag

string | null

Example:

"1"

parent.sequence_id

string | null

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

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

Example:

"3"

parent.name

string

フォルダの名前。

Example:

"Contracts"

item_status

enum<string>

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

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

利用可能なオプション:

active,

trashed,

deleted

Example:

"active"

version_number

string

このファイルのバージョン番号。

Example:

"1"

comment_count

integer

このファイルに関するコメントの数。

Example:

10

permissions

object

このファイルに対して現在のユーザーが持っている権限について説明します。

表示子属性

permissions.can_delete

boolean

required

現在のユーザーがこの項目を削除できるかどうかを指定します。

Example:

true

permissions.can_download

boolean

required

現在のユーザーがこの項目をダウンロードできるかどうかを指定します。

Example:

true

permissions.can_invite_collaborator

boolean

required

現在のユーザーがこの項目でのコラボレーションに新しいユーザーを招待できるかどうかと、この項目ですでにコラボレーションしているユーザーのロールを更新できるかどうかを指定します。

Example:

true

permissions.can_rename

boolean

required

ユーザーがこの項目の名前を変更できるかどうかを指定します。

Example:

true

ユーザーがこの項目の既存の共有リンクのアクセスレベルを変更できるかどうかを指定します。

Example:

true

ユーザーがこの項目の共有リンクを作成できるかどうかを指定します。

Example:

true

permissions.can_annotate

boolean

required

ユーザーがこのファイルに注釈を付けられるかどうかを指定します。

Example:

true

permissions.can_comment

boolean

required

ユーザーがこのファイルにコメントを追加できるかどうかを指定します。

Example:

true

permissions.can_preview

boolean

required

ユーザーがこのファイルをプレビューできるかどうかを指定します。

Example:

true

permissions.can_upload

boolean

required

ユーザーがこのファイルの新しいバージョンをアップロードできるかどうかを指定します。

Example:

true

permissions.can_view_annotations_all

boolean

required

ユーザーに対してこのファイルに付けられたすべての注釈を表示するかどうかを指定します。

Example:

true

permissions.can_view_annotations_self

boolean

required

ユーザーに対して自分がファイルに付けた注釈を表示するかどうかを指定します。

Example:

true

tags

string[]

この項目のタグ。これらのタグはBoxウェブアプリおよびモバイルアプリで項目の横に表示されます。

タグを追加または削除するには、項目の現在のタグを取得して変更してから、このフィールドを更新します。

タグの数は、1項目あたり100個までに制限され、一意のタグは会社あたり10,000個までに制限されます。

Required array length: 1 - 100 elements

Example:

["approved"]

lock

Lock · object

このファイルで保持されているロック。ロックが存在しない場合はnullになるか、過去のタイムスタンプになります。

表示子属性

lock.id

string

このロックの一意の識別子。

Example:

"11446498"

lock.type

enum<string>

値は常にlockになります。

利用可能なオプション:

lock

Example:

"lock"

lock.created_by

ユーザー (Mini) · object

ロックを作成したユーザー。

表示子属性

lock.created_by.id

string

required

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

Example:

"11446498"

lock.created_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

lock.created_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

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

Example:

"ceo@example.com"

lock.created_at

string<date-time>

このロックが作成された日時。

Example:

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

lock.expired_at

string<date-time>

このロックが期限切れになる日時。過去の日時になる場合もあります。

Example:

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

lock.is_download_prevented

boolean

ロック中でもファイルのダウンロードを許可するかどうか。

Example:

true

lock.app_type

enum<string> | null

ロックを管理しているのがユーザーではなくアプリケーションの場合、このフィールドは、ロックを保持しているアプリケーションの種類を示します。これはオープンな列挙型で、今後、値の追加により拡張される可能性があります。

利用可能なオプション:

gsuite,

office_wopi,

office_wopiplus,

other

Example:

"office_wopiplus"

extension

string

このファイルのファイル拡張子 (省略可) を示します。デフォルトでは、空の文字列に設定されます。

Example:

"pdf"

is_package

boolean

ファイルがパッケージかどうかを示します。パッケージはMacアプリケーションで一般的に使用され、iWorkファイルを含めることができます。

Example:

true

expiring_embed_link

有効期限付き埋め込みリンク · object

このフィールドをリクエストすると、iframeに埋め込まれたプレビューセッション用の有効期限付きBox Embed URLが作成されます。

このURLは60秒後に有効期限切れとなり、セッションはその60分後に有効期限切れとなります。

一部のファイルタイプは、これらの埋め込みURLでサポートされていません。Box Embedはモバイルブラウザ向けに最適化されていないため、モバイルデバイス用に設計されたウェブエクスペリエンスでは使用しないでください。多くのUI Element (ダウンロードオプションや印刷オプションなど) はモバイルブラウザに表示されない可能性があります。

表示子属性

expiring_embed_link.access_token

string<token>

リクエストされたアクセストークン。

Example:

"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ"

expiring_embed_link.expires_in

integer<int64>

このトークンが期限切れになるまでの秒数。

Example:

3600

expiring_embed_link.token_type

enum<string>

返されるアクセストークンのタイプ。

利用可能なオプション:

bearer

Example:

"bearer"

expiring_embed_link.restricted_to

リソースのスコープ · object[]

このアクセストークンで許可される権限を返します。これにより、リソース (ファイルやフォルダなど) のリストと、各リソースで許可されるスコープが提供されます。

表示子属性

expiring_embed_link.restricted_to.scope

enum<string>

リソースへのアクセスのスコープ。

利用可能なオプション:

annotation_edit,

annotation_view_all,

annotation_view_self,

base_explorer,

base_picker,

base_preview,

base_upload,

item_delete,

item_download,

item_preview,

item_rename,

item_share,

item_upload,

item_read

Example:

"item_download"

expiring_embed_link.restricted_to.object

リソース · object

ファイルまたはフォルダのリソース。他のリソースの下にネストされたときに使用されるファイルバージョンのMini版の表示。最も基本的なフォルダのBase版の表示。fieldsクエリパラメータを使用すると、最小限の数のフィールドが返されます。

リソース
リソース

表示子属性

expiring_embed_link.restricted_to.object.id

string

required

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

Example:

"12345"

expiring_embed_link.restricted_to.object.type

enum<string>

required

値は常にfolderになります。

利用可能なオプション:

folder

Example:

"folder"

expiring_embed_link.restricted_to.object.etag

string | null

Example:

"1"

expiring_embed_link.restricted_to.object.sequence_id

string | null

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

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

Example:

"3"

expiring_embed_link.restricted_to.object.name

string

フォルダの名前。

Example:

"Contracts"

expiring_embed_link.url

string<url>

このファイルの実際の有効期限付き埋め込みURL。このオブジェクトで指定されたファイルIDとアクセストークンから作成されます。

Example:

"https://cloud.app.box.com/preview/expiring_embed/..."

watermark_info

object

このファイルに適用された電子すかしに関する詳細。

表示子属性

watermark_info.is_watermarked

boolean

この項目に電子すかしが適用されているかどうかを指定します。

Example:

true

is_accessible_via_shared_link

boolean

直接共有リンクまたは親フォルダへの共有リンクを使用してファイルにアクセスできるかどうかを指定します。

Example:

true

allowed_invitee_roles

enum<string>[]

このファイルを共有するときに招待できるユーザーの役割タイプのリスト。

利用可能なオプション:

editor,

viewer,

previewer,

uploader,

previewer uploader,

viewer uploader,

co-owner

Example:

["editor"]

is_externally_owned

boolean

このファイルが認証済みの会社以外のユーザーによって所有されているかどうかを指定します。

Example:

true

has_collaborations

boolean

このファイルに他のコラボレータが存在するかどうかを指定します。

Example:

true

metadata

項目メタデータインスタンス · object

このファイルに追加されたメタデータインスタンスを含むオブジェクト。

各メタデータインスタンスは、そのscopeとtemplateKeyによって一意に識別されます。各ファイルに追加されるメタデータテンプレートのインスタンスは1つだけです。各メタデータインスタンスは、キーとしてtemplateKeyが指定されているオブジェクト内にネストされ、さらにそのオブジェクト自体もキーとしてscopeが指定されているオブジェクト内にネストされます。

表示子属性

metadata.{key}

object

scopeおよびtemplateKeyのキー/値ペア内にネストされている、メタデータインスタンスのリスト。

表示子属性

metadata.{key}.{key}

メタデータインスタンス (Full) · object

ファイルまたはフォルダに適用された、メタデータテンプレートのインスタンス。ファイルまたはフォルダに適用された、メタデータテンプレートのインスタンス。メタデータインスタンスのBase版の表示。

表示子属性

metadata.{key}.{key}.$parent

string

このメタデータインスタンスが追加されている項目の識別子。これは、親のtypeとidを{type}_{id}という形式で組み合わせたものです。

Example:

"folder_59449484661,"

metadata.{key}.{key}.$template

string

テンプレートの名前。

Example:

"marketingCollateral"

metadata.{key}.{key}.$scope

string

このテンプレートが適用されているスコープのID。これは、この会社で使用するために定義されたテンプレートの場合はenterprise_{enterprise_id}、Boxを使用するすべての会社が利用できる一般的なテンプレートの場合はglobalになります。

Example:

"enterprise_27335"

metadata.{key}.{key}.$version

integer

メタデータインスタンスのバージョン。このバージョンは0から始まり、ユーザー定義プロパティが変更されるたびに増加します。

Example:

1

metadata.{key}.{key}.$canEdit

boolean

このメタデータインスタンスをユーザーが編集できるかどうか。

Example:

true

metadata.{key}.{key}.$id

string<uuid>

メタデータインスタンスを識別するためのUUID。

Maximum string length: 36

Example:

"01234500-12f1-1234-aa12-b1d234cb567e"

metadata.{key}.{key}.$type

string

このインスタンスの「タイプ」に対応する一意の識別子。これは内部システムプロパティであるため、クライアントアプリケーションでは使用しないでください。

Example:

"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0"

metadata.{key}.{key}.$typeVersion

integer

オブジェクトテンプレートの既知の最新バージョン。これは内部システムプロパティであるため、クライアントアプリケーションでは使用しないでください。

Example:

2

metadata.{key}.{key}.{key}

any

メタデータテンプレートに存在する各フィールドの値。global.propertiesテンプレートの場合、汎用的なキー/値ペアをテンプレートに保存できるため、0個以上のフィールドのリストにすることができます。

Example:

"Aaron Levie"

Example:

{
  "marketingCollateral": {
    "$canEdit": true,
    "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
    "$parent": "folder_59449484661",
    "$scope": "enterprise_27335",
    "$template": "marketingCollateral",
    "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
    "$typeVersion": 2,
    "$version": 1
  }
}

Example:

{
  "enterprise_27335": {
    "marketingCollateral": {
      "$canEdit": true,
      "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
      "$parent": "folder_59449484661",
      "$scope": "enterprise_27335",
      "$template": "marketingCollateral",
      "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
      "$typeVersion": 2,
      "$version": 1
    }
  }
}

expires_at

string<date-time> | null

ファイルが自動的に削除される日時。

Example:

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

representations

Representations · object

アプリケーション内でファイルのプレースホルダを表示するために使用できるレプリゼンテーションのリスト。デフォルトでは、すべてのレプリゼンテーションが返されるため、x-rep-hintsヘッダーを使用して目的のレプリゼンテーションをさらにカスタマイズすることをお勧めします。

表示子属性

representations.entries

object[]

ファイルのリスト。

表示子属性

representations.entries.content

object

レプリゼンテーションを実際に取得するために使用できるURLを含むオブジェクト。

表示子属性

representations.entries.content.url_template

string

レプリゼンテーションを取得するために使用できるダウンロードURL。このエンドポイントに対しては必ず認証済みAPIコールを行ってください。

このURLはテンプレートであるため、{+asset_path}を実際のパスに置き換える必要があります。通常、ページ付けが行われていないレプリゼンテーションの場合は、空の文字列に置き換えることができます。

ページ割りされたレプリゼンテーションの場合は、1.pdfなど、リクエストするページにファイル拡張子を付けた文字列で{+asset_path}を置き換えます。

ダウンロードURLをリクエストする際には、以下の追加クエリパラメータを渡すことができます。

set_content_disposition_type - 配置タイプとしてinlineまたはattachmentのいずれかを指定してAPIレスポンスのContent-Dispositionヘッダーを設定します。このパラメータを指定しない場合、レスポンスにContent-Dispositionヘッダーは含まれません。
set_content_disposition_filename - Content-Dispositionヘッダーで使用するレプリゼンテーションのファイル名をアプリケーションで定義できます。定義しない場合は、Boxのソースファイル名から派生したファイル名とレプリゼンテーション拡張子の組み合わせがファイル名になります。

Example:

"https://dl.boxcloud.com/api/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048/content/{+asset_path}?watermark_content=4567"

representations.entries.info

object

このレプリゼンテーションの詳細を取得するために使用できるURLを含むオブジェクト。

表示子属性

representations.entries.info.url

string

このファイルレプリゼンテーションの詳細を取得するために使用できるAPI URL。このエンドポイントに対しては必ず認証済みAPIコールを行ってください。

Example:

"https://api.box.com/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048"

representations.entries.properties

object

このプレゼンテーションのサイズとタイプを含むオブジェクト。

表示子属性

representations.entries.properties.dimensions

string<<width>x<height>>

このレプリゼンテーションの幅と高さ。

Example:

"2048x2048"

representations.entries.properties.paged

string

レプリゼンテーションが複数のページで構成されているかどうかを示します。

Example:

"true"

representations.entries.properties.thumb

string

そのレプリゼンテーションをファイルのサムネイルとして使用できるかどうかを示します。

Example:

"true"

representations.entries.representation

string

返されたレプリゼンテーションのファイルタイプを示します。

Example:

"png"

representations.entries.status

object

このレプリゼンテーションのステータスを含むオブジェクト。

表示子属性

representations.entries.status.state

enum<string>

レプリゼンテーションのステータス。

successはそのレプリゼンテーションが表示可能な状態であることを示します。
viewableは視聴可能な動画であることを示します。
pendingはそのレプリゼンテーションがこれから生成されることを示します。ステータスを再確認するにはこのエンドポイントを再試行します。
noneはリクエストされたときにレプリゼンテーションが再作成されることを示します。この生成をトリガーするには、infoオブジェクトで定義されたURLをリクエストします。

利用可能なオプション:

success,

viewable,

pending,

none

Example:

"success"

classification

object

このファイルに適用された分類に関する詳細

表示子属性

classification.name

string

分類の名前。

Example:

"Top Secret"

classification.definition

string

この分類の意味の説明。

Example:

"Content that should not be shared outside the company."

classification.color

string

ユーザーインターフェースでの分類ラベルの表示に使用される色。色は、Boxウェブアプリで分類を作成した管理者または共同管理者によって定義されます。

Example:

"#FF0000"

uploader_display_name

string

ファイルをアップロードしたユーザーの表示名。ほとんどの場合、これはアップロード時点でログインしているユーザーの名前です。

このファイルのアップロードに、ユーザーに対してメールアドレスの入力を要求するファイルリクエストフォームが使用された場合、このフィールドにはそのメールアドレスが設定されます。メールアドレスがファイルリクエストフォームで要求されなかった場合、このフィールドは、File Requestという値を返すように設定されます。

メールアドレスが指定されなかったその他すべての匿名のケースでは、このフィールドの値がデフォルトでSomeoneになります。

Example:

"Ellis Wiggins"

disposition_at

string<date-time> | null

特定のファイルのリテンションの有効期限のタイムスタンプ。

Example:

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

shared_link_permission_options

enum<string>[] | null

このファイルを共有するときに招待できるユーザーの役割タイプのリスト。

利用可能なオプション:

can_preview,

can_download,

can_edit

Example:

["can_preview"]

is_associated_with_app_item

boolean

ファイルまたはファイルの先祖が1つ以上のアプリ項目に関連付けられている場合、このフィールドはtrueを返します。コンテキストユーザーがそのファイルに関連付けられたアプリ項目にアクセスできない場合でもtrueが返されることに注意してください。

Example:

true