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

ファイルをダウンロードします。フォルダのダウンロードには対応していません。

/files/view　apiとの違いは、レスポンスヘッダーのContent-Disposition, Content-Type値だけです。

HTTP リクエスト

POST http://<ホスト名>/fileblog/api/v3/files/download
Authorization: Bearer <アクセストークン>
Content-Type: application/json; charset=utf-8

{
path:"/DocRoot/sample.txt"
}

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

リクエストパラメータ

名前	型	説明
path	String, 必須	ファイルのパスを指定します。パスについてはこちらをご覧ください。

レスポンス

HTTP/1.1 200 OK
Content-Dispostion=attachment
Content-Type=application/force-download
<ファイル本文>

リクエストが成功すると、レスポンスコードが200、レスポンスにファイル本体が返されます。

レスポンスパラメータ

なし。

エラーレスポンス

pathに指定されたファイルが見つかりません

HTTP/1.1 404 File Not Found
{
"error": {
"message": "指定されたパスが見つかりません。 (2) (/DocRoot/sample.txt)"
}
}

pathに指定されたファイルが存在しません。値を確認してください。

pathに指定されたファイルに読み取り権限がありません

HTTP/1.1 404 File Not Found
{
"error": {
"message": "アクセスが拒否されました。 (5) (/DocRoot/sample.txt)"
}
}

pathに指定されたファイルに読み取り権限がありません。

フォルダのダウンロードはできません

HTTP/1.1 404 File Not Found
{
"error": {
"message": "You can not download a folder (/DocRoot/subDir)"
}
}

pathにフォルダパスが指定されています。

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