ファイルの共有リンクを取得

このリソースは、バージョン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フィールドを明示的にリクエストします。

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

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

表示子属性

description

string

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

Maximum string length: 255

Example:

"Contract for Q1 renewal"

size

integer

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

Example:

629644

path_collection

パスのコレクション · object

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

表示子属性

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

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

表示子属性

modified_by

ユーザー (Mini) · object

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

表示子属性

owned_by

ユーザー (Mini) · object

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

表示子属性

shared_link

共有リンク · object

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

表示子属性

parent

フォルダ (Mini) · object

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

表示子属性

item_status

enum<string>

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

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

利用可能なオプション:

active,

trashed,

deleted

Example:

"active"

version_number

string

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

Example:

"1"

comment_count

integer

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

Example:

10

permissions

object

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

表示子属性

tags

string[]

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

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

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

Required array length: 1 - 100 elements

Example:

["approved"]

lock

Lock · object

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

表示子属性

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 (ダウンロードオプションや印刷オプションなど) はモバイルブラウザに表示されない可能性があります。

表示子属性

watermark_info

object

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

表示子属性

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が指定されているオブジェクト内にネストされます。

表示子属性

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ヘッダーを使用して目的のレプリゼンテーションをさらにカスタマイズすることをお勧めします。

表示子属性

classification

object

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

表示子属性

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