ファイルアップロード

ファイルアップロード

添付ファイルフィールドにファイルをアップロードするAPIです。

• アップロードされたファイルのファイルキーを利用して、レコード登録やレコード更新などで利用できます。
• 一度にアップロードできるファイルは、一つです。

HTTP メソッド

POST

URI

https://(サブドメイン名).cybozu.com/k/v1/file.json

ゲストスペース内のアプリの場合

https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/file.json

リクエスト形式

• リクエストは multipart/form-data 形式で送信します。 詳細は RFC1867、RFC2388 を参照してください。
• ファイル名は Content-Disposition 内の filename で指定して下さい。
  ※日本語ファイル名の場合は UTF8 でエンコードした内容を指定して下さい。

リクエストの例

リクエストヘッダを含んだ例）

ファイル内容が「test」の test.txt ファイルを送信した場合

POST /k/v1/file.json HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: cnlvX2Z1a3VkYTpjeWJvenU=
Content-Type: multipart/form-data; boundary=---------------------------bee48a285354
Content-Length: 188

-----------------------------bee48a285354
Content-Disposition: form-data; name="file"; filename="test.txt"
Content-Type: text/plain

test

-----------------------------bee48a285354--

レスポンスの例

アップロードされたファイルのファイルキーが返されます。 ファイルキーは、レコード登録やレコード更新を行なう API で添付ファイルフィールドの値として使用します（後述）。

取得したファイルキーを、登録や更新の API 実行時に、添付ファイルフィールドの値として、以下のように使用します。

リクエストヘッダ(レコード更新 API 使用時の場合)

PUT /k/v1/record.json HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

• Content-Type に application/json を指定して下さい。 指定しない場合は JSON が解釈できないため、実行時エラーとなります。

ボディ(レコード更新 API 使用時の場合)

制限事項

• アップロードされたファイルは、レコード登録 API やレコード更新 API によってレコードに添付しない場合には、3日間で削除されます。
• 一時保管領域に保管された状態のファイルも、ディスク使用量に含まれます。

その他につきましては、制限事項 をご確認ください。

関連Tips

• ファイルアップロードで必須となる3つの手順

JavaScriptサンプル

XMLHttpRequest