サーバー構築不要!スマートフォンアプリ向けの新クラウド

トップ >ドキュメント >REST API リファレンス:オブジェクト検索

共通ドキュメント

オブジェクト検索

オブジェクト検索APIについて

クエリ条件に合致したオブジェクトの情報取得を行います。
クエリ条件を指定しない場合は全件取得となります。
※値が設定されている項目のみ返却されます。

基本仕様

  • APIパス
    • 全件検索:/classes/クラス名
    • 指定検索:/classes/クラス名?where=
  • メソッド:GET

リクエストヘッダー

シグネチャやAPIキーなどの詳細は「共通フォーマット」を参照してください。

フィールド名 内容
Content-Type application/json

リクエストコンテント

追加フィールドは、対象となるクラス/フィールドに依存しており、複数存在する場合もあります。
※フィールド名に「_id」は指定不可とします。

パラメータ名 説明 データ型 必須 バリデーション
objectId オブジェクトID 文字列
- 追加フィールド - フィールド名のフォーマットチェック
(半角英数+「_」のみ)
createDate 登録日時 日付型
updateDate 更新日時 日付型
acl ACL オブジェクト

HTTPステータス

ステータスコード 説明
200 検索完了

レスポンスヘッダー

フィールド名
Content-Type application/json

レスポンスコンテント

{"results":[{(オブジェクト情報1)},{(オブジェクト情報2)},{}…]}の配列が返却されます。
以下、オブジェクト情報を記載しています。

パラメータ名 説明 データ型 備考
objectId オブジェクトID 文字列
- 追加フィールド -
createDate 登録日時 日付型
updateDate 更新日時 日付型
acl ACL オブジェクト

リクエストサンプル

curl -X GET -G \
 -H "X-NCMB-Application-Key:549116a86b0ebbec4832d4086a56f36c82a5d64bc6528fa5e6220be76db5ef45" \
 -H "X-NCMB-Timestamp:2013-09-10T02:44:35.452Z" \
 -H "X-NCMB-Signature: bqPSP/7iXvjDRhrsSX9zasAfvgqvyeAKMJIU3/yLaX4=" \
 -H "Content-Type: application/json" \
 --data-urlencode 'where={"name":"curl"}' \
 https://mb.api.cloud.nifty.com/2013-09-01/classes/cmd

レスポンスサンプル

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
  "results":[
    {
      "objectId":"8FgKqFlH8dZRDrBJ",
      "createDate":"2013-08-09T07:37:54.869Z",
      "updateDate":"2013-08-09T07:37:54.869Z",
      "acl":{
        "*":{
          "read":true,
          "write":true
        }
      },
      "name":"curl"
    },
    {
      "objectId":"wMhDqUcnIam6QoaJ",
      "createDate":"2013-08-09T07:40:55.108Z",
      "updateDate":"2013-08-09T07:40:55.108Z",
      "acl":{
        "*":{
          "read":true,
          "write":true
        }
      },
      "name":"curl"
    },
    {
      "objectId":"eP201juECv4KRkEd",
      "createDate":"2013-08-09T07:43:41.652Z",
      "updateDate":"2013-08-09T07:43:41.652Z",
      "acl":{
        "*":{
          "read":true,
          "write":true
        }
      },
      "name":"curl"
    },
    {
      "objectId":"sOPjNZp9VOcNvpOI",
      "createDate":"2013-08-14T10:33:27.016Z",
      "updateDate":"2013-08-14T10:33:27.016Z",
      "acl":{
        "*":{
          "read":true,
          "write":true
        }
      },
      "name":"curl"
    },
    {
      "objectId":"qPKakmgffLp28nnI",
      "createDate":"2013-08-14T10:52:03.921Z",
      "updateDate":"2013-08-14T10:52:03.922Z",
      "acl":{
        "*":{
          "read":true,
          "write":true
        }
      },
      "name":"curl"
    }
  ]
}

お探しの内容が見つからなかった場合はユーザーコミュニティ もご活用ください。(回答保証はいたしかねます)
なお、 Expertプラン以上のお客様はテクニカルサポートにてご質問を承らせて頂きます。

推奨画面サイズ1024×768px以上

ページの先頭へ