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

プレビューファイル保存フォルダのダウンロードの準備をします(Zipアーカイブ化のキューを登録する)。実際のダウンロードはdowlnload_tpi/downloadにて行います。

HTTP リクエスト

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

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

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

リクエストパラメータ

名前	型	説明
path	String, 必須	プレビューファイル保存フォルダをダウンロードしたいファイルのパスを指定します。パスについてはこちらをご覧ください。

レスポンス

HTTP/1.1 200 OK
{
"fileid":"636657408"
}

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

レスポンスパラメータ

名前	値	説明
fileid	String	ダウンロード用に発行されたfileの一時IDです。この値を/files/download_tpi/downloadに渡します。

エラーレスポンス

tpi（プレビュー)が未作成です

HTTP/1.1 403 Forbidden
{
"error": {
"message": "tpi not found (/DocRoot/.tpi/sample.txt)"
}
}

このAPIは作成済みのtpi（プレビュー）をzip化しますが、プレビュー未作成のファイルに対してプレビューを作成しません。プレビュー未作成のファイルの対してこのAPIを実行すると上記のようにエラーが返ります。

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