下載檔案

連結已複製

在附件欄位中指定檔案鍵以下載檔。

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獲取的檔鍵。請參閱檔案鍵。

檔鍵

連結已複製

上傳和下載檔案時使用兩種類型的「檔案鍵」：

用上傳文件API取得的檔鍵
上傳檔案的API
- 例：c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6
- 例如，用於將存儲在臨時存儲中的檔與附件欄位相關聯。
- 不是此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"
}

範例程式碼

使用網頁瀏覽器的Fetch API傳送請求

有關FetchAPI的更多資訊，請參閱以下頁面。
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的三種方法及其使用方法

限制事項

連結已複製

該API不能用發送kintone REST API請求的API執行。
傳送kintone REST API請求

kintone API

kintone API文件

下載檔案

目錄

請求參數

檔鍵

回應

回應標頭

所需存取權限

範例

補充

限制事項