get_metadata

<< Click to Display Table of Contents >>

Navigation:  API V3 マニュアル > リファレンス > files >

get_metadata

ファイル/フォルダの情報を取得します。

HTTP リクエスト

POST http://<ホスト名>/fileblog/api/v3/files/get_metadata
Authorization: Bearer <アクセストークン>
Content-Type: application/json; charset=utf-8
 
{
 path:"/DocRoot/sample.txt"
}

※アクセストークンについてはこちらをご覧ください。

リクエストパラメータ

名前

説明

path

String, 必須

フォルダのパスを指定します。パスについてはこちらをご覧ください。

attributes

String

追加して取得したい属性があれば指定します。カンマ区切りで属性名を列挙してください。指定できる属性名については/files/list_folderを参照してください。

レスポンス

HTTP/1.1 200 OK
{
 "name": "sample.txt",
 "path": "/DocRoot",
 "creationtime": "2000-01-01T00:00:00.000Z",
 "lastwritetime": "2000-01-01T00:00:00.000Z",
 "is_dir": false,
 "size": 1024
}

リクエストが成功すると、レスポンスコードが200、レスポンスボディにJson形式で結果が返されます。

レスポンスパラメータ

名前

説明

name

String

ファイル、フォルダ名です。

path

String

親フォルダのパスです。

creationtime

Timestamp

作成日時(ISO8601 形式)です。

lastwritetime

Timestamp

更新日時(ISO8601 形式)です。

is_dir

Boolean

ディレクトリの場合はtrueが返されます。

size

Integer

ファイルサイズです。フォルダの場合は-1になります。

attributes

 

attributesを指定した場合にdescription, comment, physicalpathが設定されます。

エラーレスポンス

※エラーについてはこちらをご覧ください。