ファイル (詳細)

任意のファイルAPIエンドポイントからデフォルトで返される可能性がある、ファイルの完全版レプリゼンテーション

このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。

詳細バリアントに含まれるフィールドは、fieldsパラメータをサポートするAPIエンドポイントによって返すことができます。たとえば、IDでファイルを取得するときに、fieldsリクエストパラメータをid,typeに設定すると、これらのフィールドのみがAPI応答で返されます。

string
12345

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

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

string
file

次の値に固定: file

["editor"]

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

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

#FF0000

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

Content that should not be shared outside the company.

この分類の意味の説明。

Top Secret

分類の名前

10

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

string / date-time
2012-12-12T10:53:43-08:00

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

string / date-time
2012-12-12T10:53:43-08:00

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

string / date-time
2012-12-12T10:53:43-08:00

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

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

Contract for Q1 renewal256

このファイルの説明(省略可)

string
1

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

string / date-time
2012-12-12T10:53:43-08:00

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

string
pdf

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

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

true

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

true

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

boolean
true

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

active

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

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

次の値のいずれか1つ: active,trashed,deleted

object

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

string
11446498

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

string
lock

次の値に固定: lock

string / date-time
2012-12-12T10:53:43-08:00

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

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

string / date-time
2012-12-12T10:53:43-08:00

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

true

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

associative array

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

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

associative array

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

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

string / date-time
2012-12-12T10:53:43-08:00

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

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

string
Contract.pdf

ファイルの名前

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

このファイルが配置されているフォルダ。

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

この項目の親フォルダ

1

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

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

true

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

true

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

true

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

true

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

true

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

true

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

true

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

true

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

true

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

true

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

true

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

true

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

string / date-time
2012-12-12T10:53:43-08:00

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

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

ファイルのリスト

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

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

レプリゼンテーションを取得するために使用できるダウンロード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のソースファイル名から派生したファイル名とレプリゼンテーション拡張子の組み合わせがファイル名になります。

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

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

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

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

string / <width>x<height>
2048x2048

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

true

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

true

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

png

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

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

success

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

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

次の値のいずれか1つ: success,viewable,pending,none

3

この項目に適用された最新のユーザーイベントを表す数値の識別子。

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

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

string / digest
85136C79CBF9FE36BB9D05D0639C70C265C18D37

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

integer
629644

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

string array
["approved"]

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

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

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

string / date-time
2012-12-12T10:53:43-08:00

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

Ellis Wiggins

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

このファイルをアップロードしたのがログアウトしていたユーザーで、アップロード時にメールアドレスが指定された場合は、このフィールドによってそのメールアドレスが返されます。

このファイルがファイルリクエストフォームを使用してアップロードされた場合、このフィールドは、File Requestという値を返すように設定されます。メールアドレスは追加されません。

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

1

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

このフォルダに適用された電子すかしに関する詳細

true

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

レスポンスの例

{
  "id": 12345,
  "type": "file",
  "allowed_invitee_roles": [
    "editor"
  ],
  "classification": {
    "color": "#FF0000",
    "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,
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "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",
          "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
          "file_version": {
            "id": 12345,
            "type": "file_version",
            "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
          }
        }
      }
    ],
    "token_type": "bearer",
    "url": "https://cloud.app.box.com/preview/expiring_embed/..."
  },
  "extension": "pdf",
  "file_version": {
    "id": 12345,
    "type": "file_version",
    "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
  },
  "has_collaborations": true,
  "is_externally_owned": true,
  "is_package": true,
  "item_status": "active",
  "lock": {
    "id": 11446498,
    "type": "lock",
    "created_at": "2012-12-12T10:53:43-08:00",
    "created_by": {
      "id": 11446498,
      "type": "user",
      "login": "ceo@example.com",
      "name": "Aaron Levie"
    },
    "expired_at": "2012-12-12T10:53:43-08:00",
    "is_download_prevented": true
  },
  "metadata": {
    "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
      }
    }
  },
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": 11446498,
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "name": "Contract.pdf",
  "owned_by": {
    "id": 11446498,
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "parent": {
    "id": 12345,
    "type": "folder",
    "etag": 1,
    "name": "Contracts",
    "sequence_id": 3
  },
  "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",
  "uploader_display_name": "Ellis Wiggins",
  "version_number": 1,
  "watermark_info": {
    "is_watermarked": true
  }
}