Search

Catalyst Searchは、Catalyst Data Storeのテーブルのインデックス付きカラムでのデータ検索を可能にします。アプリケーションにSearchを統合すると、エンドユーザーは単一の検索クエリでData Store内の大量のデータを強力に検索できるようになります。

検索クエリの実行

説明

このAPIは、Data Store内のすべてのテーブルのインデックス付きカラムで検索操作を実行できるようにします。リクエストJSONで検索パラメータを渡すことができます。検索クエリに一致するレコードがレスポンスとして取得されます。

リクエスト詳細

リクエストURL

POST

{api-domain}/baas/v1/project/{project_id}/search

copy

api-domain

URL

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

project_id

Numerical

プロジェクトの一意のID

リクエストヘッダー

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

オプションヘッダー

CATALYST-ORG: {org_id}

Environment: Development

スコープ

ZohoCatalyst.search.READ

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

リクエストJSONプロパティ

search string

mandatory

検索するキーワードを含む検索パターン

複数のキーワードをカンマで区切って指定できます。

search_table_columns json

mandatory

テーブル内で検索するインデックス付きカラム

以下の形式で指定する必要があります:

{“table_name_1”: [“column_name_1”, “column_name_2”, “column_name_3”..], “table_name_2”: [“column_name_1”, “column_name_2”, “column_name_3”..]..}

select_table_columns json

optional

検索結果に基づいて選択・表示するカラム

以下の形式で指定する必要があります:

{“table_name_1”: [“column_name_1”, “column_name_2”, “column_name_3”..], “table_name_2”: [“column_name_1”, “column_name_2”, “column_name_3”..]..}

order_by json

optional

検索結果で取得したレコードを昇順または降順でソートします

許可される値: ASC、DESC

start integer

optional

検索を開始する行の開始インデックス

デフォルト値: 0

end integer

optional

検索を終了する行のオフセット値

デフォルト値: 500

レスポンス詳細

レスポンスは、検索クエリに一致するレコードを返します。CREATORIDやCREATEDTIMEなどのメタデータを含む行の詳細、およびカラムのキー名と値が返されます。

リクエスト例
copy

curl -X POST 

https://api.catalyst.zoho.com/baas/v1/project/4000000006007/search 

-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57” 

-H “Content-Type: application/json” 

-d ‘{
“search” : “Mary”,
“search_table_columns” : {
“CustomerInfo”: [
“CustomerName”,
“TrainerName”
]
},
“start”:1000,
“end”:200
}’

レスポンス例
copy

         {
"status": "success",
"data": {
    "CustomerInfo": [
        {
            "CREATORID": "56000000002003",
            "MODIFIEDTIME": "2019-02-08 13:13:44",
            "CustomerName": "Mary Johnson",
            "TrainerName": "Helena Stewart",
            "CustomerID":"PL1213234",
            "CREATEDTIME": "2019-02-08 13:13:44"
        },
        {
            "CREATORID": "56000000002003",
            "MODIFIEDTIME": "2019-02-08 20:11:10",
            "CustomerName": "Mary Palmer",
            "TrainerName": "Ronald Wazlib",
            "CustomerID":"SY091834",
            "CREATEDTIME": "2019-02-08 20:11:10"
        },
       {
            "CREATORID": "56000000002003",
            "MODIFIEDTIME": "2019-11-09 10:00:12",
            "CustomerName": "Herbert Spielberg",
            "TrainerName": "Mary Amber Rogers",
            "CustomerID":"AL987627",
            "CREATEDTIME": "2019-11-08 00:12:40"
        }
    ]
}
}


    

Search Data- Java SDK

Search Data- Node.js SDK

Search Data- Python SDK

Search Data- Web SDK

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit