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

JSONオブジェクトを検索する

JSON オブジェクトを検索します。

基本仕様

HTTPメソッド

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

エンドポイント

JSON オブジェクトの検索はエンドポイントの指定方法の違いにより、下記表に記述するような検索結果の特徴があります。

  • オブジェクトIDを指定して1件検索する。

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

  • 条件を指定して複数件のオブジェクトを検索する。

/v1/dat/{データストアID}/{アプリID}/{コレクションID}/<取得開始位置>-<取得終了位置>;<検索条件>;(*)?<クエリパラメータ>

※取得開始位置、取得終了位置の数値は省略可能ですが、間の-(ハイフン)は省略できません。
(*)検索条件はマトリクスパラメーター形式;(セミコロン区切り)で複数条件指定可能です。データ検索における条件式を参照。

リクエスト

ヘッダ

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

クエリ

クエリ名 備考
access_token アクセストークン(*1)
proc get もしくは count 省略する場合 get がデフォルト。countは特殊で、検索結果のオブジェクト数を取得する
sel オブジェクトのフィールド名をカンマ区切りで複数記述可能 取得対象とするフィールド
excpt オブジェクトのフィールド名をカンマ区切りで複数記述可能 取得除外対象とするフィールド
order オブジェクトのフィールド名をカンマ区切りで複数記述可能 ソートキーとするフィールド
oonly true もしくは false (デフォルトはfalse) trueの場合取得結果の中でオブジェクトのみを取得する

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

レスポンス

ヘッダ

Content-Type application/json

HTTPステータス

ステータスコード 内容
200 成功
400 取得範囲不適切、検索条件不適切、取得対象/取得除外対象とするパラメータを両方指定、ソートキー不適切など。
401 トークン未指定。認証失敗。
403 アプリにアクセスする権限がない。(コレクションに create 権限がない。コレクションに格納可能なオブジェクトが “JSON データ” ではない。)
404 コレクション未作成
500 予期せぬエラー発生

コンテント

レスポンスボディは検索結果の情報に加え、結果のオブジェクト数の総計数、取得したオブジェクト一覧のJSON データの前後に結果が存在するかなどの情報が付与されます。

オブジェクト一覧以外のフィールドに関して下記表に記述します。

フィールド名 内容
_total オブジェクト結果総件数
_objs 取得したオブジェクト一覧、配列
_start 一覧取得したオブジェクトの第一要素を総件数から見た場合の位置
_end 一覧取得したオブジェクトの最終要素を総件数から見た場合の位置
_prev 一覧取得したオブジェクトの前にオブジェクトが存在するか
_next 一覧取得したオブジェクトの後ろにオブジェクトが存在するか

例)Curlコマンド

例1)オブジェクトIDを指定して取得

例2)オブジェクトの一覧を取得(条件指定、取得フィールドを指定)

検索対象のJSON オブジェクトは以下のイメージ

例3)オブジェクト数を出力する

この場合のレスポンスは下記のような形となる

例4)件数を指定して特定のフィールドのみ取得する(1件目~10件目を取得)