上傳CSV檔案

information

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

目錄

上傳CSV檔案

將檔上傳到臨時存儲。
臨時存儲是臨時存儲使用此 API 上傳的檔的臨時存儲位置。

  • 通過將上傳檔的檔鍵與其他 API 一起使用,您可以將臨時存儲中的檔案附加到記錄、空間等。
  • 您一次只能上傳一個檔。
  • 可以使用 API 檢索記錄的檔鍵不可用於檔案上傳。

URL

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

HTTP 方法

POST

所需許可權

關於上傳檔的訪問許可權,請參考 用於附加檔的 API 所需的許可權,例如用於註冊/更新記錄的 API。

請求

  • 請求以 multipart/form-data 格式發送。 有關詳細資訊,請參閱 RFC 1867 和 RFC 7578。
  • 為"Content-Disposition "指定"file",filename 為"Content-Disposition name "指定檔名。
    對於日語檔名,請指定UTF-8編碼的內容。
參數

示例請求
URL

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

頁眉
1
2
3
4
{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "multipart/form-data"
}

關於請求頭,請參見 kintone REST API的通用規範

HTTP 標頭資訊
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
POST /k/v1/file.json HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-API-Token: TOKEN
Content-Type: multipart/form-data; boundary=---------------------------bee48a285354
Content-Length: 188
-----------------------------bee48a285354
Content-Disposition: form-data; name="file"; filename="sample.txt"
Content-Type: text/plain

test
-----------------------------bee48a285354--

回應

財產
屬性名稱 說明
fileKey 字串 上傳檔的文件金鑰
檔鍵用作用於附加檔的 API 中附件欄位的值。
有關詳細資訊,請參閱 欄位格式
示例回應
1
2
3
{
  "fileKey": "c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6"
}

示例代碼

使用 curl 的請求
1
2
3
curl -X POST 'https://sample.cybozu.com/k/v1/file.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -F 'file=@sample.txt'
使用 Fetch API (External link) 的請求
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const blob = new Blob(['這是一個測試文件'], {
  type: 'text/plain',
});
const formData = new FormData();
// 上傳檔 API 是 POST 方法,因此請設置 CSRF 令牌
formData.append('__REQUEST_TOKEN__', kintone.getRequestToken());
formData.append('file', blob, 'test.txt');

const headers = {
  'X-Requested-With': 'XMLHttpRequest',
};
const resp = await fetch('/k/v1/file.json', {
  method: 'POST',
  headers,
  body: formData,
});
const respData = await resp.json();
console.log(respData);

檔鍵

有兩種類型的”檔鍵”用於上傳和下載檔:

  • 要獲取的文件金鑰以回應 上傳檔 API
    • 例:c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6
    • 例如,用於將存儲在臨時存儲中的檔與附件欄位相關聯。
    • 可以使用此 API 獲取的檔鍵
  • 檢索記錄 的 API 可以獲取的附件的檔鍵
    • 例:201202061155587E339F9067544F1A92C743460E3D12B3297
    • 例如,從附件欄位下載檔時會使用它。
    • 它不是可以使用此 API 檢索的文件金鑰。

限制

  • 該介面不能 通過發送kintone REST API請求的API 執行。
  • 如果存儲在臨時存儲中的檔未附加到記錄、空間等,則會在三天后刪除。
  • 臨時存儲中的檔也包含在磁碟使用量中。