REST API リファレンス
- ドキュメントトップ
-
共通
-
プッシュ通知
-
会員管理・認証
-
データストア
-
ファイルストア
-
スクリプト
共通ドキュメント
オブジェクト登録
Contents |
オブジェクト登録APIについて
指定したクラスに対して、オブジェクトの登録を行います。
リクエストのコンテントは、登録対象のフィールド名と登録データの値を1セットとし、
登録するフィールド分だけ配列形式で指定します。
※ 指定クラスが存在しない場合、アプリからのクラス作成設定を有効にしていると新規クラス作成後にオブジェクトの登録を行います。
基本仕様
- APIパス:/classes/クラス名
- メソッド:POST
リクエスト
ヘッダー
シグネチャやAPIキーなどの詳細は「共通フォーマット」を参照してください。
フィールド名 | 内容 |
---|---|
Content-Type | application/json |
コンテント
複数のフィールドを追加で作成することが可能です。
※フィールド名に「_id」を指定することはできません。
ACL未指定時の初期値はシステム側であらかじめ設定されているデフォルト値になります。
詳細はACLフォーマットをご覧ください。
REST APIでは、文字列、数値、配列、オブジェクトなどのデータを扱うことができるほか、特殊なデータ型も利用可能です。
詳細はREST API リファレンス 共通フォーマットをご覧ください。
パラメータ名 | 説明 | データ型 | 必須 | バリデーション |
---|---|---|---|---|
- | 追加フィールド | - | フィールド名のフォーマットチェック (半角英数+「_」のみ) |
|
acl | ACL | オブジェクト |
レスポンス
HTTPステータス
ステータスコード | 説明 |
---|---|
201 | 登録完了 |
ヘッダー
フィールド名 | 値 |
---|---|
Content-Type | application/json |
Location | https://mbaas.api.nifcloud.com/2013-09-01/classes/クラス名/オブジェクトID |
コンテント
パラメータ名 | 説明 | データ型 | 備考 |
---|---|---|---|
createDate | 登録日時 | 日付型 | |
objectId | オブジェクトID | 文字列 |
リクエストサンプル
curl -X POST \
-H "X-NCMB-Apps-Session-Token: MfwFcXy6RHmCgVzBQnu3e6yOM" \
-H "X-NCMB-Application-Key: 549116a86b0ebbec4832d4086a56f36c82a5d64bc6528fa5e6220be76db5ef45" \
-H "X-NCMB-Timestamp: 2013-08-14T15:46:25.543" \
-H "X-NCMB-Signature: 201K2oRBN3tgAhMCrd9PZH84wuBVdrwm+nzAlNhAavw=" \
-H "Content-Type: application/json" \
-d '{"name": "orange", "type": "fruit"}' \
https://mbaas.api.nifcloud.com/2013-09-01/classes/food
レスポンスサンプル
HTTP/1.1 201 Created
Location: https://mbaas.api.nifcloud.com/2013-09-01/classes/food/U6TztFwTDrGSD88N
{"createDate":"2013-08-28T03:02:29.970Z","objectId":"U6TztFwTDrGSD88N"}
お探しの内容が見つからなかった場合はユーザーコミュニティ
もご活用ください。(回答保証はいたしかねます)
なお、 Expertプラン以上のお客様はテクニカルサポートにてご質問を承らせて頂きます。
推奨画面サイズ1024×768px以上