Loading...

お知らせ:

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

アイテムの取得

説明

このAPIを使用すると、プロジェクト内のNoSQLテーブルからアイテムを取得できます。テーブルは一意のIDまたは名前で参照されます。

取得するアイテムの属性を指定でき、マスターまたはスレーブクラスターから取得する必要があるかどうかも指定できます。

リクエスト詳細

リクエストURL

GET

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

copy

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

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

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

リクエストヘッダー

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

オプションヘッダー

CATALYST-ORG: {org_id}

Environment: Development

スコープ

ZohoCatalyst.nosql.item.READ

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

リクエストJSONプロパティ

keys json
mandatory
テーブルのパーティションキーとソートキーを示します。
required_attributes json
optional
返される属性のリスト。
consistent_read json
optional
読み取りをマスターまたはスレーブから行うかを宣言します。falseに設定すると、スレーブからクエリされます。許容される値:true、false。

レスポンス詳細

レスポンスには、取得操作のステータスと取得されたアイテムが返されます。アイテムのすべての属性または指定された属性が取得されます。

リクエスト例
copy

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

レスポンス例
copy
{
"status": "success",
"data": {
    fetched_attributes:{
"item": {
"EmpID": {
"N": "10999"
},
"FirstName":{
"S": "Paul"
},
"LastName":{
"S": "Smith"
},
"PriorExperience":{
"BOOL": false
}
}
}
}
}