Box Developerドキュメント
ログイン

Folder

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

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

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

string
12345

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

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

string
folder

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になる場合があります。

ユーザー (Mini) object

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

string
Legal contracts for the new ACME deal
256

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

string
1

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

object

以下のオプションのいずれかがtrueの場合、folder_upload_emailパラメータはnullではありません。

  • [このフォルダへのメールによるアップロードを許可する] および [このフォルダのコラボレータにのみメールによるアップロードを許可する] が管理コンソールで1フォルダに対して有効になっていて、ユーザーには少なくともアップロード権限が付与されています。

  • [このフォルダへのメールによるアップロードを許可する] の設定が管理コンソールで1フォルダに対して有効になっていて、[このフォルダのコラボレータにのみメールによるアップロードを許可する] の設定が無効 (オフ) になっています。

条件が満たされていない場合、パラメータには次の値が設定されます: folder_upload_email: null

string
open

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

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

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

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

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

string (email)
upload.Contracts.asd7asd@u.box.com

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

Items object

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

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

string
active

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

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

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

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

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

ユーザー (Mini) object

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

string
Contracts

フォルダの名前。

ユーザー (Mini) object

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

フォルダ (Mini) object

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

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

object

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

フォルダ (Mini) array

この項目の親フォルダ

integer (int64)
1

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

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

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

string
3

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

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

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

object

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

string
open

この共有リンクのアクセスレベル

  • open - このリンクを知っている全員にこの項目へのアクセスを許可します
  • company - 同じ会社のユーザーにのみこの項目へのアクセスを許可します
  • collaborators - この項目のコラボレータとなっているユーザーに対してのみこの項目へのアクセスを許可します

共有リンクの作成時にこのフィールドを省略した場合は、Enterprise管理者によって指定されたデフォルトのアクセスレベルに設定されます。

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

integer
3

この項目がダウンロードされた回数。

string (url)
https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg

ファイルをダウンロードするために使用できるURL。このURLをブラウザで使用すると、ファイルをダウンロードできます。このURLには、ファイルを正しいファイルタイプで保存できるように、ファイル拡張子が含まれます。

フォルダの場合、このプロパティはnullになります。

string
company

共有リンクの実際のアクセスレベル。許可されるアクセスレベルが会社の設定で制限されている場合は、accessフィールドの値よりも低いアクセスレベルになることがあります。

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

string
can_download

この共有リンクの実際の権限。これらにより、共有リンクの権限と、管理者、所有者、任意の先祖項目 (フォルダなど) によって設定される項目の権限の組み合わせの制限が厳しくなります。

次の値のいずれか1つ: can_edit,can_download,can_preview,no_access

boolean
true

共有リンクを通じて項目にアクセスする際にパスワードを要求するかどうかを定義します。

object

このリンクを通じてユーザーが項目のプレビュー、編集、およびダウンロードを行うことを許可するかどうかを定義します。これらの権限は、共有リンクのみに適用され、その項目自体に適用される権限より優先されることはありません。

boolean
true

共有リンクを通じて項目をダウンロードすることを許可するかどうかを定義します。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。

実際のアクセスレベルがcollaboratorsではなく、openまたはcompanyに設定されている場合は、この値をtrueに設定できます。

boolean
false

共有リンクからの項目の編集を許可するかどうかを定義します。

can_downloadがtrueで、項目のタイプがfileの場合のみ、この値もtrueに設定できます。

boolean
true

共有リンクを通じて項目をプレビューすることを許可するかどうかを定義します。

この値は常にtrueです。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。

integer
3

この項目がプレビューされた回数。

string (date-time)
2018-04-13T13:53:23-07:00

このリンクが共有解除される日時。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。

string (url)
https://www.box.com/s/vspke7y05sb214wjokpk

Box上の項目にアクセスするために使用できるURL。

このURLに移動すると、BoxのプレビューUIに項目が表示され、許可されている場合は、このUIからファイルをダウンロードできます。

このURLは、この共有リンクに対してカスタムのvanity_urlが 設定されている場合でも動作します。

string
my_url

vanity_urlフィールドで使用される、共有リンクのカスタム名。

string (url)
https://acme.app.box.com/v/my_url/

Boxで項目をプレビューする目的にも使用できる「カスタムURL」。カスタムURLの作成と変更は、Boxウェブアプリケーションでのみ行えます。

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",
  "folder_upload_email": {
    "access": "open",
    "email": "upload.Contracts.asd7asd@u.box.com"
  },
  "item_collection": {
    "entries": [
      {
        "etag": "1",
        "id": "12345",
        "type": "file",
        "file_version": {
          "id": "12345",
          "type": "file_version",
          "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
        },
        "name": "Contract.pdf",
        "sequence_id": "3",
        "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
        "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",
        "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"
        },
        "owned_by": {
          "id": "11446498",
          "type": "user",
          "login": "ceo@example.com",
          "name": "Aaron Levie"
        },
        "parent": {
          "etag": "1",
          "id": "12345",
          "type": "folder",
          "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",
        "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",
        "allowed_invitee_roles": [
          "editor"
        ],
        "classification": {
          "color": "#FF0000",
          "definition": "Content that should not be shared outside the company.",
          "name": "Top Secret"
        },
        "comment_count": 10,
        "disposition_at": "2012-12-12T10:53:43-08:00",
        "expires_at": "2012-12-12T10:53:43-08:00",
        "expiring_embed_link": {
          "access_token": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ",
          "expires_in": 3600,
          "restricted_to": [
            {
              "object": {
                "etag": "1",
                "id": "12345",
                "type": "folder",
                "name": "Contracts",
                "sequence_id": "3"
              },
              "scope": "item_download"
            }
          ],
          "token_type": "bearer",
          "url": "https://cloud.app.box.com/preview/expiring_embed/..."
        },
        "extension": "pdf",
        "has_collaborations": true,
        "is_accessible_via_shared_link": true,
        "is_associated_with_app_item": true,
        "is_externally_owned": true,
        "is_package": true,
        "lock": {
          "app_type": "office_wopiplus",
          "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",
          "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": "marketingCollateral",
              "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
              "$typeVersion": 2,
              "$version": 1
            }
          }
        },
        "permissions": {
          "can_delete": true,
          "can_download": true,
          "can_invite_collaborator": true,
          "can_rename": true,
          "can_set_share_access": true,
          "can_share": true,
          "can_annotate": true,
          "can_comment": true,
          "can_preview": true,
          "can_upload": true,
          "can_view_annotations_all": true,
          "can_view_annotations_self": true
        },
        "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"
              }
            }
          ]
        },
        "shared_link_permission_options": [
          "can_preview"
        ],
        "tags": [
          "approved"
        ],
        "uploader_display_name": "Ellis Wiggins",
        "version_number": "1",
        "watermark_info": {
          "is_watermarked": true
        }
      }
    ],
    "limit": 1000,
    "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
    "offset": 2000,
    "order": [
      {
        "by": "type",
        "direction": "ASC"
      }
    ],
    "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
    "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": [
      {
        "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",
  "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"
}