フォルダ (詳細)

任意のフォルダAPIエンドポイントからデフォルトで返される可能性がある、フォルダの完全版表記。

This resource has a few variations that can be encountered when using the API.

The fields that are part of the full variant can be returned by API endpoints that support the fields parameter. For example, by defining the fields request parameter as id,type when requesting a file by ID, only those fields will be returned in the API response.

string
12345

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

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

string
folder

Value is always folder

["editor"]

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

true

フォルダの所有者ではないユーザーが そのフォルダに新しいコラボレータを招待できるかどうかを指定します。

true

このフォルダの所有者ではないコラボレータが このフォルダの他のコラボレータを表示できないように制限するかどうかを 指定します。

この制限を有効にした場合は、所有者ではないユーザーが新しいコラボレータを 招待することも制限されます。

このフォルダに適用された分類に関する詳細。

#FF0000

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

Content that should not be shared outside the company.

この分類の意味の説明。

Top Secret

分類の名前

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に設定すると、どのメールアドレスからのメールでも 受け入れられます。

Value is one of open,collaborators

upload.Contracts.asd7asd@u.box.com

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

true

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

true

このフォルダへの招待を社内のユーザーのみに限定するかどうかを指定します。既存のコラボレーションには影響しません。

true

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

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

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

active

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

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

Value is one of active,trashed,deleted

associative array

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

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

associative array

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

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

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

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

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

string
Contracts

フォルダの名前。

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

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

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

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

この項目の親フォルダ

1

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

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

true

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

true

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

true

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

true

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

true

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

true

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

true

ユーザーがこのフォルダにアップロードできるかどうかを指定します。

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

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

3

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

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

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

integer / int64
629644

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

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

string
synced

フォルダをユーザーのデバイスに同期する必要があるかどうかを指定します。 これはBox Sync(廃止済み)で使用され、Box Driveでは 使用されません。

Value is one of synced,not_synced,partially_synced

string array
["approved"]

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

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

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

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

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

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

true

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

Response Example

{
  "id": 12345,
  "type": "folder",
  "allowed_invitee_roles": [
    "editor"
  ],
  "allowed_shared_link_access_levels": [
    "open"
  ],
  "can_non_owners_invite": true,
  "can_non_owners_view_collaborators": true,
  "classification": {
    "color": "#FF0000",
    "definition": "Content that should not be shared outside the company.",
    "name": "Top Secret"
  },
  "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"
  },
  "has_collaborations": true,
  "is_collaboration_restricted_to_enterprise": true,
  "is_externally_owned": true,
  "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",
  "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": "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
  },
  "permissions": {
    "can_delete": true,
    "can_download": true,
    "can_invite_collaborator": true,
    "can_rename": true,
    "can_set_share_access": true,
    "can_share": true,
    "can_upload": true
  },
  "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_name": "my_url",
    "vanity_url": "https://acme.app.box.com/v/my_url/"
  },
  "size": 629644,
  "sync_state": "synced",
  "tags": [
    "approved"
  ],
  "trashed_at": "2012-12-12T10:53:43-08:00",
  "watermark_info": {
    "is_watermarked": true
  }
}