ファイルをダウンロードする

固定リンクがコピーされました

添付ファイルフィールドのファイルキーを指定して、ファイルをダウンロードします。

HTTPメソッド	GET
URL	https://sample.cybozu.com/k/v1/file.json
URL（ゲストスペース）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/file.json
認証	パスワード認証 , APIトークン認証 , セッション認証 , OAuth認証
Content-Type	application/json（URLにパラメーターを含める場合は不要）

リクエストパラメーター

固定リンクがコピーされました

パラメーター名	型	必須	説明
fileKey	文字列	必須	ダウンロードするファイルのファイルキーレコードを取得するAPIなどで取得したファイルキーを指定します。ファイルキーを参照してください。

ファイルキー

固定リンクがコピーされました

ファイルのアップロードやダウンロードで使用する「ファイルキー」は、次の2種類あります。

ファイルをアップロードするAPIのレスポンスとして取得するファイルキー
ファイルをアップロードするAPI
- 例：c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6
- 一時保管領域に保存されたファイルを、添付ファイルフィールドなどに関連付けるときに使用します。
- このAPIで指定するファイルキーではありません。
レコードを取得するAPIなどで取得する、添付ファイルのファイルキー
レコードを取得するAPI
- 例：201202061155587E339F9067544F1A92C743460E3D12B3297
- 添付ファイルフィールドなどから、ファイルをダウンロードするときに使用します。
- このAPIで指定するファイルキーです。

レスポンス

固定リンクがコピーされました

レスポンスヘッダー

固定リンクがコピーされました

レスポンスヘッダーのContent-TypeにダウンロードしたファイルのMIMEタイプが返ります。
レスポンスボディには、ファイルの内容が入ります。

必要なアクセス権

固定リンクがコピーされました

アプリのレコード閲覧権限
ダウンロードするファイルが添付されたレコードの閲覧権限
ダウンロードするファイルが添付されたフィールドの閲覧権限

サンプル

固定リンクがコピーされました

サンプルリクエスト

リクエストURL（URLにパラメーターを含める場合）

1

https://sample.cybozu.com/k/v1/file.json?fileKey=201202061155587E339F9067544F1A92C743460E3D12B3297

リクエストヘッダー（URLにパラメーターを含める場合）

1
2
3


{
  "X-Cybozu-API-Token": "API_TOKEN"
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

リクエストURL（リクエストボディにパラメーターを含める場合）

1

https://sample.cybozu.com/k/v1/file.json

リクエストヘッダー（リクエストボディにパラメーターを含める場合）

1
2
3
4


{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

リクエストボディ（リクエストボディにパラメーターを含める場合）

1
2
3


{
  "fileKey": "201201e271307126747563577E9431C85B3B26D4AFB1509193"
}

サンプルコード

WebブラウザーのFetch APIを使ったリクエスト

Fetch APIの詳細は次のページを参照してください。
Fetch API

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17


try {
  const {record} = kintone.app.record.get();
  const {fileKey} = record['添付ファイル'].value[0];
  const headers = {
    'X-Requested-With': 'XMLHttpRequest',
  };
  const resp = await fetch(`/k/v1/file.json?fileKey=${fileKey}`, {
    method: 'GET',
    headers,
  });
  const blob = await resp.blob();
  const url = window.URL || window.webkitURL;
  const blobUrl = url.createObjectURL(blob);
  console.log(blobUrl);
} catch (err) {
  console.error(err);
}

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

1
2
3


curl -X GET 'https://sample.cybozu.com/k/v1/file.json?fileKey=201202061155587E339F9067544F1A92C743460E3D12B3297' \
  -H 'X-Cybozu-API-Token: {API_TOKEN}' \
  -o ./sample.txt

補足

固定リンクがコピーされました

「GET」リクエストの使い方の中、最も一般的な方法は「URLにパラメーターを含める」です。
その他のリクエストの方法や、詳細は次のページを参考にしてください。
REST APIでGETを使う3つの方法とその使い分けについて

制限事項

固定リンクがコピーされました

このAPIは、kintone REST APIリクエストを送信するAPIでは実行できません。
kintone REST APIリクエストを送信する

kintone API

kintone APIドキュメント