9.5. ファイルメタデータの取得¶
-
GET
/1/
(tenantId)/files/
(bucketName)/
(fileName)/meta
¶ ファイル1件のメタデータを取得する。
Request Headers: - X-Application-Id -- アプリケーションID(必須)
- X-Application-Key -- アプリケーションキー(必須)
- X-Session-Token -- セッショントークン(オプション)
Parameters: - bucketName (string) -- バケット名
- fileName (string) -- ファイル名
Query Parameters: - published (int) -- 1を指定すると公開済みファイル一覧のみ取得となる
- deleteMark (int) -- 1を指定すると、論理削除ファイルも含む
Status Codes: - 200 OK -- 正常に受け付けた
- 400 Bad Request -- パラメータ不正
- 401 Unauthorized -- 認証エラー
- 403 Forbidden -- 権限エラー
- 404 Not Found -- 該当バケットまたはファイルが存在しない
Response JSON Object: - _id (string) -- ファイルID
- filename (string) -- ファイル名
- contentType (string) -- Content-Type
- length (int) -- ファイルサイズ
- ACL (object) -- ACL
- createdAt (string) -- 作成日時
- updatedAt (string) -- 更新日時
- metaETag (string) -- メタデータETag
- fileETag (string) -- ファイルETag
- cacheDisabled (boolean) -- キャッシュ無効フラグ
- publicUrl (string) -- 公開URL
- options (object) -- オプション
- _deleted (boolean) -- 論理削除フラグ
レスポンスボディ
ファイルメタデータが JSON で得られる。以下に例を示す。
{ "_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" } }
deleteMark パラメータに1を指定した場合、論理削除されたメタデータも読み込まれる。
論理削除されたデータは、"_deleted" フィールドに true が設定されている。 この場合、サーバ側でファイル本体は削除されているが、メタデータは削除されずに残っている状態である。