Loading...

お知らせ:

当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

テーブルのクエリ

説明

このAPIを使用すると、プロジェクト内のNoSQLテーブルをクエリしてデータを取得できます。テーブルは一意のIDで参照されます。

リクエスト詳細

リクエストURL

POST

{api-domain}/baas/v1/project/{{project_id}}/nosqltable/{{table_identifier}}/item/query

copy

api-domain
URL
Catalyst APIにアクセスするためのDC固有のドメイン

project_id
Numerical
プロジェクトの一意のID

table_identifier
Numerical
テーブルの一意のIDまたはテーブル名

リクエストヘッダー

Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json

オプションヘッダー

CATALYST-ORG: {org_id}

Environment: Development

スコープ

ZohoCatalyst.nosql.POST

注意: この操作は、Catalyst SDKを使用してCatalystユーザー認証権限でも実行できます。詳細については、Catalyst API前提条件セクションを参照してください。

リクエストJSONプロパティ

key_condition json
mandatory
アイテムのCRUD操作と同様の形式で条件を含みます。パーティションキーとソートキーの条件のみ指定できます。パーティションキーには「equals」演算子のみ使用できます。条件はパーティションキー = 値、またはパーティションキーのequals条件とソートキー条件を含むグループにできます。サポートされる演算子の完全なリストを参照してください。
required_attributes json
optional
返される属性のリスト。
consistent_read json
optional
読み取りをマスターまたはスレーブから行うかを宣言します。falseに設定すると、スレーブからクエリされます。許容される値:true、false。
other_condition json
optional
取得されたデータに適用される条件です。これらの条件が適用された後にレスポンスが送信されます。
forwardScan json
optional
クエリを昇順または降順で実行するかを示すために使用します。
startKey json
optional
ページネーション目的で次のデータアイテムセットを取得するために使用します。
additional_sort_key json
optional
追加のソートキーを持つテーブルに対してクエリが行われるかどうかを示すために使用します。追加のソートキー属性名を含みます。
limit json
optional
返されるアイテムの最大件数を示します。

レスポンス詳細

レスポンスには、クエリ操作のステータスと、クエリで設定された条件に従って取得されたアイテムが返されます。

リクエスト例
copy

curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/nosqltable/3376000003171728/item/query
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d -d ‘{ key_condition:{ partition_key:{ “S”:“Country” }, sort_key:{ “N”:“EmpID” }, } required_attributes: { “EmpID”, “FirstName”, “LastName”, “PriorExperience” }, consistent_read: “true” }’

レスポンス例
copy

{ “status”: “success”, “data”: { fetched_data:{ “item”: { “EmpID”: { “N”: “10999” }, “FirstName”:{ “S”: “Paul” }, “LastName”:{ “S”: “Smith” }, “PriorExperience”:{ “BOOL”: false } } } } }