Folder

任意のフォルダAPIエンドポイントからデフォルトで返される、フォルダの標準レプリゼンテーション

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

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

string
12345

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

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

string
folder

次の値に固定: folder

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

このフォルダが最初に作成された日時。

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

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

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

このフォルダが作成された日時。ルートフォルダや ごみ箱フォルダなど、一部のフォルダの場合、 この値はnullになる場合があります。

このフォルダを作成したユーザー

Legal contracts for the new ACME deal256

このフォルダの説明(省略可)

string
1

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

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

自動的に削除されるフォルダとその日時。

open

このパラメータが設定されている場合、 ユーザーは、このフォルダに対して自動的に作成されたメールアドレスに メールでファイルを送信できます。

メールアドレスを作成するには、フォルダを作成するとき、または更新するときに このプロパティを設定します。

collaboratorsに設定すると、コラボレータの登録済み メールアドレスからのメールのみが受け入れられます。 これには、ユーザーが登録しているすべてのメールエイリアスも含まれます。

openに設定すると、どのメールアドレスからのメールでも 受け入れられます。

次の値のいずれか1つ: open,collaborators

upload.Contracts.asd7asd@u.box.com

このフォルダのアップロードメールアドレス(省略可)。

フォルダ内の項目のページ。

このフィールドをリクエストできるのは、フォルダの情報をクエリで照会するときのみで、 フォルダの項目をクエリで照会するときにはリクエストできません。

active

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

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

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

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

このフォルダが最後に更新された日時。ルートフォルダやごみ箱フォルダなど、 一部のフォルダの場合、この値は nullになる場合があります。

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

string
Contracts

フォルダの名前。

このフォルダを所有するユーザー。

このフォルダが配置されているフォルダ(省略可)

ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、 この値はnullになることがあります。

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

この項目の親フォルダ

1

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

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

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

3

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

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

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

integer / int64
629644

フォルダサイズ(バイト単位)。

この整数を解析する際には、値が非常に大きくなる ことがあるため注意が必要です。

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

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

レスポンスの例

{
  "id": 12345,
  "type": "folder",
  "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": "Legal contracts for the new ACME deal",
  "etag": 1,
  "expires_at": "2012-12-12T10:53:43-08:00",
  "folder_upload_email": {
    "access": "open",
    "email": "upload.Contracts.asd7asd@u.box.com"
  },
  "item_collection": {
    "entries": [
      {
        "id": 12345,
        "etag": 1,
        "type": "file",
        "sequence_id": 3,
        "name": "Contract.pdf",
        "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
        "file_version": {
          "id": 12345,
          "type": "file_version",
          "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
        }
      }
    ],
    "limit": 1000,
    "offset": 2000,
    "order": [
      {
        "by": "type",
        "direction": "ASC"
      }
    ],
    "total_count": 5000
  },
  "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": "Contracts",
  "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
  },
  "purged_at": "2012-12-12T10:53:43-08:00",
  "sequence_id": 3,
  "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,
  "trashed_at": "2012-12-12T10:53:43-08:00"
}