メインコンテンツへスキップ
APIバージョン 2024.0 ごみ箱から復元されたフォルダを表します。
​
id
string
例 123456789フォルダを表す一意の識別子。フォルダIDを確認するには、ウェブアプリケーションでフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folders/123の場合、folder_idは123です。
​
type
string
例 folder値は常にfolderになります。次の値に固定: folder
​
content_created_at
string(date-time)
例 2012-12-12T10:53:43-08:00このフォルダが最初に作成された日時。
​
content_modified_at
string(date-time)
例 2012-12-12T10:53:43-08:00このフォルダが最後に更新された日時。
​
created_at
string(date-time)
例 2012-12-12T10:53:43-08:00このフォルダが作成された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値はnullになる場合があります。
​
created_by
ユーザー (Mini)object
このフォルダを作成したユーザー。
​
description
string
例 Legal contracts for the new ACME dealこのフォルダの説明 (省略可)。
​
etag
string
例 1このフォルダのHTTP etag。これは変更が発生した場合 (またはしなかった場合) にフォルダに対して変更を行う目的でのみ、If-MatchおよびIf-None-Matchヘッダー内の一部のAPIエンドポイントで使用できます。
​
folder_upload_email
string
このフォルダのフォルダアップロード用メールアドレス。フォルダがごみ箱に移動された場合、元のアップロード用メールアドレスが再度アクティブになっても、これはnullになります。
​
item_status
string
例 activeこの項目が削除されたかどうかを定義します。
  • active - 項目がごみ箱に移動されていない場合。
  • trashed - 項目がごみ箱に移動されているが、まだ削除されていない場合。
  • deleted - 項目がすでに完全に削除されている場合。
次の値のいずれか1つ: active,trashed,deleted
​
modified_at
string(date-time)
例 2012-12-12T10:53:43-08:00このフォルダが最後に更新された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値はnullになる場合があります。
​
modified_by
ユーザー (Mini)object
このフォルダを最後に変更したユーザー。
​
name
string
例 Contractsフォルダの名前。
​
owned_by
ユーザー (Mini)object
このフォルダを所有するユーザー。
​
parent
フォルダ (Mini)object
このフォルダが配置されているフォルダ (省略可)ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値はnullになることがあります。
​
path_collection
object
ルートフォルダを起点にした、このファイルを含むフォルダツリー。
​
purged_at
string
このフォルダがごみ箱から削除される予定日時。復元後はnullになります。
​
sequence_id
string
例 3この項目に適用された最新のUser Eventを表す数値の識別子。これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventのsequence_idが最初に取得されたリソースのsequence_idよりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。
​
shared_link
string
このファイルの共有リンク。フォルダがごみ箱に移動された場合、元の共有リンクが再度アクティブになっても、これはnullになります。
​
size
integer(int64)
例 629644フォルダサイズ (バイト単位)。この整数を解析する際には、値が非常に大きくなることがあるため注意が必要です。
​
trashed_at
string
このフォルダがごみ箱に移動された日時。復元後はnullになります。
{
  "id": "123456789",
  "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": "null",
  "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": "null",
  "sequence_id": "3",
  "shared_link": "null",
  "size": 629644,
  "trashed_at": "null"
}