REST API JSONオブジェクトAPI
最終更新日 2015-9-1

JSONオブジェクトを更新する

JSON オブジェクトを更新します。

基本仕様

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

HTTPメソッド

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

エンドポイント

  • 単一オブジェクトの複数のフィールドを更新する。

/v1/dat/{データストアID}/{アプリID}/{コレクションID}/{オブジェクトID}

  • 単一オブジェクトの1つのフィールドを更新する。

/v1/dat/{データストアID}/{アプリID}/{コレクションID}/{オブジェクトID}/{フィールド名}

リクエスト

ヘッダ

Content-Type application/json
X-APPIARIES-TOKEN アクセストークンを指定します(*1)

クエリ

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

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

レスポンス

ヘッダ

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

HTTPステータス

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

コンテント

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

エラーコード一覧

エラーコード値 分類 内容
0060002 コンテントボディ コンテント名不適切
0060003 コンテントボディ コンテント値変更不可
0060011 コンテントボディ LF, CR, TAB を除く制御文字が含まれている。
0060101 オブジェクトID null, 空文字
0060102 オブジェクトID 文字列ではない
0060104 オブジェクトID URI 書式が間違っている
0060109 オブジェクトID オブジェクトIDが使用済み
0060201 座標 null
0060202 座標 配列ではない
0060204 座標 《配列要素》座標ではない
0063101 $unset null。
0063102 $unset 配列ではない
0063104 $unset 《配列要素》指定できない文字列
0063105 $unset 《配列要素》null, 空文字
0063106 $unset 《配列要素》文字列ではない

例)curlコマンド