ファイルをダウンロードする
ファイルキー を指定してファイルをダウンロードします。
URL
- 通常のアプリ
- https://sample.cybozu.com/k/v1/file.json
- ゲストスペースのアプリ
- https://sample.cybozu.com/k/guest/
ゲストスペース ID
/v1/file.json
HTTP メソッド
GET
必要なアクセス権
- アプリのレコード閲覧権限
- ダウンロードするファイルが添付されたレコードの閲覧権限
- ダウンロードするファイルが添付されたフィールドの閲覧権限
リクエスト
パラメーター
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
fileKey | 文字列 | 必須 | ダウンロードするファイルのファイルキー レコードを取得する API などで取得したファイルキーを指定します。 |
リクエストの例(URL にパラメーターを含める場合)
URL
https://sample.cybozu.com/k/v1/file.json?fileKey=201202061155587E339F9067544F1A92C743460E3D12B3297
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。
リクエストの例(リクエストボディにパラメーターを含める場合)
URL
https://sample.cybozu.com/k/v1/file.json
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。
ボディ
|
|
レスポンス
ヘッダー
レスポンスヘッダーの Content-Type にダウンロードしたファイルの MIME タイプが返ります。
レスポンスボディには、ファイルの内容が入ります。
サンプルコード
curl を使ったリクエスト
|
|
Fetch API
を使ったリクエスト
|
|
ファイルキー
ファイルのアップロードやダウンロードで使用する「ファイルキー」は、次の 2 種類あります。
-
ファイルをアップロードする API のレスポンスとして取得するファイルキー
- 例:
c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6
- 一時保管領域に保存されたファイルを、添付ファイルフィールドなどに関連付けるときに使用します。
- この API で指定するファイルキーではありません。
- 例:
-
レコードを取得する API などで取得する、添付ファイルのファイルキー
- 例:
201202061155587E339F9067544F1A92C743460E3D12B3297
- 添付ファイルフィールドなどから、ファイルをダウンロードするときに使用します。
- この API で指定するファイルキーです。
- 例:
制限事項
- この API は、 kintone REST API リクエストを送信する API では実行できません。