File
任意のファイルAPIエンドポイントからデフォルトで返される可能性がある、ファイルの完全版レプリゼンテーション
1このファイルのHTTP etag。これは変更が発生した場合(またはしなかった場合)にファイルに対して変更を行う目的でのみ、If-MatchおよびIf-None-Matchヘッダー内の一部のAPIエンドポイントで使用できます。
12345ファイルを表す一意の識別子。
ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123の場合、file_idは123です。
file次の値に固定: file
Contract.pdfファイルの名前
3この項目に適用された最新のユーザーイベントを表す数値の識別子。
これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるユーザーイベントを除外できます。
たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するユーザーイベントの発生を監視する場合などがこれに該当します。ユーザーイベントのsequence_idが最初に取得されたリソースのsequence_idよりも小さいか同じである場合、アプリケーションはそのようなユーザーイベントをすべて無視します。
["editor"]このファイルを共有するときに招待できるユーザーの役割タイプのリスト。
2012-12-12T10:53:43-08:00このファイルが最初に作成された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。
2012-12-12T10:53:43-08:00このフォルダが最後に更新された日時。この日時はフォルダがBoxにアップロードされた時点よりも前になる場合があります。
2012-12-12T10:53:43-08:00Box上でこのファイルが作成された日時。
このファイルを作成したユーザー
Contract for Q1 renewal256このファイルの説明(省略可)
ファイルの現在のバージョンに関する情報。
trueこのフォルダに他のコラボレータが存在するかどうかを指定します。
trueこのフォルダが認証済みの会社以外のユーザーによって 所有されているかどうかを指定します。
activeこの項目が削除されたかどうかを定義します。
active- 項目がごみ箱に移動されていない場合。trashed- 項目がごみ箱に移動されているが、まだ削除されていない場合。deleted- 項目がすでに完全に削除されている場合。
次の値のいずれか1つ: active,trashed,deleted
2012-12-12T10:53:43-08:00Boxでこのフォルダが最後に更新された日時。
このファイルを最後に変更したユーザー
このファイルを所有するユーザー
このファイルが配置されているフォルダ。
ルートフォルダを起点にした、このファイルを含むフォルダツリー。
この項目の親フォルダ
1このリスト内のフォルダの数。
2012-12-12T10:53:43-08:00このファイルがごみ箱から削除される予定日時。
85136C79CBF9FE36BB9D05D0639C70C265C18D37ファイルのSHA1ハッシュ。Box上のファイルとローカルファイルの内容を比較する目的に使用できます。
629644ファイルサイズ(バイト単位)。この整数を解析する際には、非常に大きな数値となって整数オーバーフローになる可能性があるため、注意が必要です。
["approved"]この項目のタグ。これらのタグは Boxウェブアプリおよびモバイルアプリで項目の横に表示されます。
タグを追加または削除するには、項目の現在のタグを取得して 変更してから、このフィールドを更新します。
タグの数は、1項目あたり100個までに制限され、一意のタグは会社あたり10,000個までに 制限されます。
2012-12-12T10:53:43-08:00このファイルがごみ箱に移動された日時。
レスポンスの例
{
"allowed_invitee_roles": [
"editor"
],
"classification": {
"color": {
"background": "#FF0000",
"foreground": "#FF00CC"
},
"definition": "Content that should not be shared outside the company.",
"name": "Top Secret"
},
"comment_count": 10,
"content_created_at": "2012-12-12T10:53:43-08:00",
"content_modified_at": "2012-12-12T10:53:43-08:00",
"created_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": 11446498,
"login": "ceo@example.com",
"name": "Aaron Levie",
"type": "user"
},
"description": "Contract for Q1 renewal",
"etag": 1,
"expires_at": "2012-12-12T10:53:43-08:00",
"expiring_embed_link": {
"access_token": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ",
"expires_in": 3600,
"restricted_to": [
{
"scope": "item_download",
"object": {
"id": 12345,
"etag": 1,
"type": "file",
"sequence_id": 3,
"name": "Contract.pdf"
}
}
],
"token_type": "bearer",
"url": "https://cloud.app.box.com/preview/expiring_embed/..."
},
"extension": "pdf",
"file_version": {
"id": 12345,
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
"type": "file_version"
},
"has_collaborations": true,
"id": 12345,
"is_externally_owned": true,
"is_package": true,
"item_status": "active",
"lock": {
"created_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": 11446498,
"login": "ceo@example.com",
"name": "Aaron Levie",
"type": "user"
},
"expired_at": "2012-12-12T10:53:43-08:00",
"id": 11446498,
"is_download_prevented": true,
"type": "lock"
},
"metadata": {
"enterprise_27335": {
"marketingCollateral": {
"$canEdit": true,
"$id": "01234500-12f1-1234-aa12-b1d234cb567e",
"$parent": "folder_59449484661",
"$scope": "enterprise_27335",
"$template": "properties",
"$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
"$typeVersion": 2,
"$version": 1
}
}
},
"modified_at": "2012-12-12T10:53:43-08:00",
"modified_by": {
"id": 11446498,
"login": "ceo@example.com",
"name": "Aaron Levie",
"type": "user"
},
"name": "Contract.pdf",
"owned_by": {
"id": 11446498,
"login": "ceo@example.com",
"name": "Aaron Levie",
"type": "user"
},
"parent": {
"etag": 1,
"id": 12345,
"name": "Contracts",
"sequence_id": 3,
"type": "folder"
},
"path_collection": {
"entries": [
{
"id": 12345,
"etag": 1,
"type": "folder",
"sequence_id": 3,
"name": "Contracts"
}
],
"total_count": 1
},
"permissions": {
"can_annotate": true,
"can_comment": true,
"can_delete": true,
"can_download": true,
"can_invite_collaborator": true,
"can_preview": true,
"can_rename": true,
"can_set_share_access": true,
"can_share": true,
"can_upload": true,
"can_view_annotations_all": true,
"can_view_annotations_self": true
},
"purged_at": "2012-12-12T10:53:43-08:00",
"representations": {
"entries": [
{
"content": {
"url_template": "https://dl.boxcloud.com/api/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048/content/{+asset_path}?watermark_content=4567"
},
"info": {
"url": "https://api.box.com/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048"
},
"properties": {
"dimensions": "2048x2048",
"paged": true,
"thumb": true
},
"representation": "png",
"status": {
"state": "success"
}
}
]
},
"sequence_id": 3,
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"shared_link": {
"access": "open",
"download_count": 3,
"download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
"effective_access": "company",
"effective_permission": "can_download",
"is_password_enabled": true,
"permissions": {
"can_download": true,
"can_preview": true
},
"preview_count": 3,
"unshared_at": "2018-04-13T13:53:23-07:00",
"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
"vanity_url": "https://acme.app.box.com/v/my_url/"
},
"size": 629644,
"tags": [
"approved"
],
"trashed_at": "2012-12-12T10:53:43-08:00",
"type": "file",
"uploader_display_name": "Ellis Wiggins",
"version_number": 1,
"watermark_info": {
"is_watermarked": true
}
}