Box Developerドキュメント
 

    File

    このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 **Box APIのバージョン管理**を参照してください。

    任意のファイルAPIエンドポイントからデフォルトで返されるファイルのStandard版の表示。

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

    通常、Standardバリアントに含まれるフィールドは、固有のAPIエンドポイントを介してこのリソースがリクエストされたときに返されます。 たとえば、fieldsパラメータが指定されていない場合、IDでファイルを取得すると、これらのフィールドが返されます。

    string
    12345

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

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

    string
    file

    file

    次の値に固定: file

    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 renewal
    255

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

    string
    1

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

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

    active

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

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

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

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

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

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

    string
    Contract.pdf

    ファイルの名前

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

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

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

    この項目の親フォルダ

    1

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

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

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

    3

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

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

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

    string (digest)
    85136C79CBF9FE36BB9D05D0639C70C265C18D37

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

    integer
    629644

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

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

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

    レスポンスの例

    {
      "id": "12345",
      "type": "file",
      "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",
      "file_version": {
        "id": "12345",
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
      },
      "item_status": "active",
      "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": [
          {
            "etag": "1",
            "id": "12345",
            "type": "folder",
            "name": "Contracts",
            "sequence_id": "3"
          }
        ],
        "total_count": 1
      },
      "purged_at": "2012-12-12T10:53:43-08:00",
      "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_edit": false,
          "can_preview": true
        },
        "preview_count": 3,
        "unshared_at": "2018-04-13T13:53:23-07:00",
        "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
        "vanity_name": "my_url",
        "vanity_url": "https://acme.app.box.com/v/my_url/"
      },
      "size": 629644,
      "trashed_at": "2012-12-12T10:53:43-08:00"
    }