Loading...

お知らせ:

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

アイテムの更新

説明

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

カスタムJSON形式で、条件を指定してもしなくても更新する属性を渡すことができます。

リクエスト詳細

リクエストURL

PUT

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

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.item.UPDATE

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

リクエストJSONプロパティ

keys json
mandatory
テーブルのパーティションキーとソートキーを示します。
update_attributes json
mandatory

更新する属性とその値を示します。更新にはPUT(アイテム内に新しい属性を追加)とDELETE(アイテムから属性を削除)の2種類があります。attribute_pathは、実際の操作が行われるアイテム内のパスを示します。更新する値には2種類があります:

update_value json
mandatory
更新する実際の値。

update_function json
optional

使用できる4つの関数があります:
if_not_exists - 属性の存在を確認し、存在しない場合に値を宣言します。 append_list - リストにデータを追加します。 add - 既存の値に値を追加するか、セットに要素を追加します。 reduction - 既存の値から値を減算するか、セットから要素を削除します。


condition json
optional

テーブルの既存データが取得され、この条件に対して評価されます。評価がtrueの場合にのみアイテムが挿入されます。既存データがない場合、条件は無視されアイテムが挿入されます。条件を初期化するには3つの方法があります:

functions json
mandatory (if specifying condition)
2つの組み込み関数があります:属性の存在を確認するために使用できるattribute_existと、指定された属性名が指定された型に属するかどうかを確認するために使用できるattribute_typeです。

operator, attribute, value json
optional
直接比較操作を実行するために使用します。サポートされる演算子:contains、not_contains、begins_with、ends_with、in、not_in、between、not_between、equals、not_equals、greater_than、less_than、greater_equal、less_equal。

group, group operator json
optional
2つ以上の条件を組み合わせるために使用します。サポートされるグループ演算子:and、or。

negate json
optional
条件の結果を否定するために使用します。

レスポンス詳細

レスポンスには、挿入操作のステータスと、設定されている場合はtable_name、partition_key、sort_keyなど更新されたアイテムの詳細が返されます。

リクエスト例
copy

curl -X PUT
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/nosqltable/3376000003171728/item
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d ‘{ keys:{ partition_key:{ “S”:“Country” }, sort_key:{ “N”:“EmpID” }, } update_attributes:{ “item”: { “EmpID”: { “N”: “10999” }, “FirstName”:{ “S”: “Paul” }, “LastName”:{ “S”: “Smith” }, “PriorExperience”:{ “BOOL”: false }, “Location”: { “M”: { “Country”: { “S”: “USA” }, “City”: { “S”: “New York” } } } } } }’

レスポンス例
copy
{
"status": "success",
"data": {
    "table_name": "employeeDetails",
    "project_details": {
        "id": 4000000006007,
        "project_name": "EmpDatabase",
        "project_type": "Live"
    }
}
}