kintone API文件

下載檔案

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

下載檔案

連結已複製

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

URL

連結已複製

常規應用程式
https://sample.cybozu.com/k/v1/file.json
訪客空間的應用程式
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/file.json

HTTP 方法

連結已複製

GET

所需存取權限

連結已複製

  • 查看應用程式中記錄的許可權
  • 查看包含要下載的檔案的記錄的許可權
  • 查看包含要下載的檔案的欄位的許可權

請求

連結已複製

參數
參數名稱 類型 必須 說明
fileKey 字串 必須 要下載的檔案的檔鍵
指定選取記錄的 API 獲取的檔鍵。
範例請求（如果要在網址中包含參數 ）
URL

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

標頭
1
2
3

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

有關請求頭的詳細資訊，請參閱通用規格。
kintone REST API通用規範

要求範例（如果要在要求正文中包含參數）
URL

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"
}

回應

連結已複製

標頭

回應標頭的 Content-Type 傳回下載檔的 MIME 類型。
回應正文包含文件的內容。

示例代碼

連結已複製

使用 curl 的請求
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
使用 Web 瀏覽器的 Fetch API 的請求

有關 Fetch API 的更多資訊，請參閱以下頁面。
Fetch API (External link) 

 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);
}

檔鍵

連結已複製

有兩種類型的「檔鍵」用於上傳和下載檔：

  • 要獲取的檔鍵以回應上傳檔案API
    上傳檔案的 API
    • 例：c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6
    • 例如，用於將存儲在臨時存儲中的檔與附件欄位相關聯。
    • 它不是此 API 指定的檔鍵。
  • 選取記錄API可以獲取的附件的檔鍵
    獲取多條記錄
    • 例：201202061155587E339F9067544F1A92C743460E3D12B3297
    • 例如，從附件欄位下載檔時會使用它。
    • 此 API 指定的檔鍵。

限制事項

連結已複製