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

バイナリオブジェクトを更新する

バイナリオブジェクトを更新します。

基本仕様

同じオブジェクトIDで登録済みのオブジェクトのフィールドを更新する。存在しないフィールドは追加させる。存在するフィールドの値は書き換えられる。

HTTPメソッド

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

エンドポイント

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

リクエスト

ヘッダ

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

クエリ

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

コンテント

パラメータ名 備考
_type バイナリファイルのコンテントタイプ
_filename バイナリファイル名
_tags タグ バイナリファイルにひもづけるタグ情報。カンマ区切りで指定する。
_file ファイル

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

レスポンス

ヘッダ

Content-Type application/json

HTTPステータス

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

コンテント

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

エラーコード一覧

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

例) curlコマンド