ファイルをアップロードする
一時保管領域にファイルをアップロードします。
一時保管領域とは、このAPIを利用してアップロードしたファイルが一時的に保管される場所です。
- アップロードしたファイルのファイルキーを他のAPIで利用することで、一時保管領域のファイルをレコードやスペースなどに添付できます。
- 一度にアップロードできるファイルは、1つです。
- レコードを取得する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」内の
name
には「file」、filename
にはファイル名を指定してください。
日本語ファイル名の場合はUTF-8でエンコードした内容を指定してください。
パラメーター
なし
リクエストの例
URL
https://sample.cybozu.com/k/v1/file.json
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST API の共通仕様を参照してください。
HTTP ヘッダー情報
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
fileKey | 文字列 | アップロードされたファイルのファイルキー ファイルキーは、ファイルの添付に利用する API で添付ファイルフィールドの値として使用します。 詳細は フィールド形式を参照してください。 |
レスポンスの例
|
|
サンプルコード
curl を使ったリクエスト
|
|
Fetch API を使ったリクエスト
|
|
ファイルキー
ファイルのアップロードやダウンロードで使用する「ファイルキー」は、次の2種類あります。
-
ファイルをアップロードする APIのレスポンスとして取得するファイルキー
- 例:
c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6
- 一時保管領域に保存されたファイルを、添付ファイルフィールドなどに関連付けるときに使用します。
- この API で取得できるファイルキーです。
- 例:
-
レコードを取得する APIなどで取得する、添付ファイルのファイルキー
- 例:
201202061155587E339F9067544F1A92C743460E3D12B3297
- 添付ファイルフィールドなどから、ファイルをダウンロードするときに使用します。
- このAPIで取得できるファイルキーではありません。
- 例:
制限事項
- このAPIは、 kintone REST API リクエストを送信する APIでは実行できません。
- 一時保管領域に保存されたファイルは、レコードやスペースなどに添付されない場合、3日間で削除されます。
- 一時保管領域のファイルも、ディスク使用量に含まれます。