8.4. オブジェクトのロングクエリ¶
-
POST
/1/
(tenantId)/objects/
(bucketName)/_query
¶ バケット内のオブジェクトをクエリする。
オブジェクトのクエリ と機能は完全に同じである。 違いはメソッドが POST である点と、クエリ条件をクエリパラメータではなくリクエストボディで指定するためクエリ長の制限がない点のみである。
Request Headers: - X-Application-Id -- アプリケーションID(必須)
- X-Application-Key -- アプリケーションキー(必須)
- X-Session-Token -- セッショントークン(オプション)
Parameters: - bucketName (string) -- バケット名
Status Codes: - 200 OK -- 正常終了
- 400 Bad Request -- パラメータ不正
- 401 Unauthorized -- 認証エラー
- 403 Forbidden -- 権限エラー
- 404 Not Found -- バケットが存在しない
- 415 Unsupported Media Type -- Content-Type 不正
- 500 Internal Server Error -- 検索条件・プロジェクションの演算子の利用方法が正しくない、その他のエラー
- 504 Gateway Timeout -- クエリタイムアウト
リクエストボディ
クエリ条件は JSON でリクエストボディに格納する。例を以下に示す。
{ "where": {"score": {"$gt": 70} }, "order": "age,-name", "skip": 500, "limit": 100, "count": 0, "deleteMark": 0, "projection": { "name": 1, "age": 0 }, "readPreference": "primary", "timeout": 0 }
各プロパティの意味は、オブジェクトのクエリ のクエリパラメータと同じである。各プロパティはそれぞれ省略が可能。