9.4. ファイル一覧の取得

GET /1/(tenantId)/files/(bucketName)

ファイル一覧（メタデータ一覧）をダウンロードする。

Request Headers:
 
  • X-Application-Id -- アプリケーションID(必須)
  • X-Application-Key -- アプリケーションキー(必須)
  • X-Session-Token -- セッショントークン(オプション)
Parameters:
  • bucketName (string) -- バケット名
Query Parameters:
 
  • published (int) -- 1を指定すると公開済みファイル一覧のみ取得となる
  • deleteMark (int) -- 1を指定すると、論理削除ファイルも含む
Status Codes:
Response JSON Object:
 
  • results (array) -- ファイルメタデータの配列
  • currentTime (string) -- サーバ現在時刻

クエリパラメータの詳細

published パラメータに 1 を指定した場合、公開されたファイルのメタデータのみが読み込まれる。

deleteMark パラメータに 1 を指定した場合、論理削除されたメタデータも読み込まれる。 削除マークされたデータは、"_deleted" フィールドに true が設定されている。

レスポンス

レスポンスボディの例を示す。 各ファイルのメタデータは JSON 配列で results に格納される。

{
  "currentTime": "2014-11-18T07:34:22:242Z",
  "results": [
    {
      "_id": "533d31c43cbc3dd2d0b32cd1",
      "filename": "hello.txt",
      "contentType": "text/plain",
      "length": 12,
      "ACL": { },
      "createdAt": "2013-08-27T04:37:30.000Z",
      "updatedAt": "2013-08-27T04:37:30.000Z",
      "metaETag": "8c92c97e-01a7-11e4-9598-53792c688d1b",
      "fileETag": "8c92c97e-01a7-11e4-9598-53792c688d1c",
      "cacheDisabled": false,
      "publicUrl": "http://....",
      "options": {
        "owner": "日電 太郎",
        "fileVersion": "1.0.0"
      }
    }
  ]
}

メタデータには以下の情報が含まれる。

  • _id: メタデータのID
  • filename : ファイル名
  • contentType : Content-Type
  • length: ファイルサイズ (バイト数)
  • ACL: ACL
  • 作成日時
  • 更新日時
  • metaETag: メタデータのETag
  • fileETag: ファイル本体のETag
  • cacheDisabled: キャッシュ禁止フラグ
  • publicUrl : 公開 URL (ファイルが公開されている場合)
  • _deleted: 削除フラグ(deleteMark パラメータに 1 を指定した場合のみ表示)
  • options: ユーザ定義メタ情報(オプション)