REST API ファイルAPI
最終更新日 2015-9-1

バイナリオブジェクトを登録する

バイナリオブジェクトを登録する

基本仕様

HTTPメソッド

メソッドはPOSTを利用します。

エンドポイント

/v1/bin/{データストアID}/{アプリID}/{コレクションID}

リクエスト

ヘッダ

Content-Type multipart/form-data
X-APPIARIES-TOKEN アクセストークンを指定します(※1)

クエリ

クエリ名 備考
access_token アクセストークン(※1)
proc create 省略可能
get true
false
省略可能。省略の場合falseがデフォルト。

コンテント

パラメータ名 備考
_id オブジェクトID 任意。省略時はランダム文字列が設定される。
_type ファイルのコンテントタイプ
_filename ファイル名
_tags タグ バイナリファイルにひもづけるタグ情報。カンマ区切りで指定する。
_file ファイル

(※1) ~ いずれかの方式で指定。

レスポンス

ヘッダ

Content-Type application/json
Location 登録されたオブジェクトを取得するためのURL

HTTPステータス

ステータスコード 内容
201 成功
401 トークン未指定。認証失敗。
403 アプリにアクセスする権限がない。コレクションに create 権限がない。コレクションに格納可能なオブジェクトが”JSONデータ”ではない。
404 コレクション未作成
409 オブジェクト登録済み
413 オブジェクトサイズ上限超え
422 コンテント不適切
500 予期せぬエラー発生
507 使用可能ストレージ容量超過

コンテント

ステータスコード409,422のとき下記のようなJSON形式でコンテントボディが返却される

エラーコード一覧

エラーコード値 分類 内容
0070001 フィールド全般 フィールド不足
0070002 フィールド全般 フィールド名不適切
0070101 オブジェクトID null, 空文字
0070102 オブジェクトID 文字列ではない
0070104 オブジェクトID URI書式ではない
0070109 オブジェクトID 使用済みのオブジェクトID
0070201 ファイル null, サイズが0
0070202 ファイル バイナリではない
0070301 ファイル名 null, 空文字
0070302 ファイル名 文字列ではない
0070303 ファイル名 LF, CR, TABを除く制御文字が含まれている。
0070401 コンテントタイプ null, 空文字
0070402 コンテントタイプ 文字列ではない
0070403 コンテントタイプ LF, CR, TABを除く制御文字が含まれている。
0071001 タグ null, 空文字
0071002 タグ 配列ではない
0071005 タグ 配列がnull
0071006 タグ 配列が文字列ではない
0071007 タグ 配列の要素数が10以上

例) curlコマンド