ZCQL
ZCQLは、Catalyst Data Store内のテーブルに対してデータの取得、挿入、更新、および削除操作を実行できるCatalyst独自のクエリ言語です。
ZCQLを使用してさまざまなDMLクエリを実行し、データの取得や操作を行うことができます。また、SQL Join句、GroupByおよびOrderByステートメント、組み込みSQL関数などのさまざまな句やステートメントを使用できます。
ZCQLクエリの実行
説明
このAPIは、ZCQLクエリを実行してData Store内のテーブルからデータを取得、挿入、更新、または削除できるようにします。サンプルリクエストに示すように、JSONリクエストでZCQLクエリを渡してこのAPIを実行できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/query
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.zcql.CREATE
リクエストJSONプロパティ
レスポンス詳細
データ取得操作: APIは、クエリ実行の結果として取得されたレコードをレスポンスとして返します。
データ挿入および更新操作: APIは、クエリを通じて挿入または更新されたレコードをレスポンスとして返します。
データ削除操作: APIは削除された行数を返します。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/query
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-d ‘{
“query”:“SELECT EmpID, EmpName, Department, Address from EmpDetails ORDER BY EmpID ASC LIMIT 1000,5”
}’
{
"status": "success",
"data": [
{
"EmpDetails": {
"CREATORID": "3376000000002003",
"MODIFIEDTIME": "2023-06-05 15:09:33:881",
"CREATEDTIME": "2023-06-05 15:09:33:881",
"ROWID": "3376000001924975",
"EmpID": "1001",
"EmpName": "Allison Powell",
"Department":"Marketing",
"Address": "13, Winter Avenue, Philadelphia, PY"
}
},
{
"EmpDetails": {
"CREATORID": "3376000000002003",
"MODIFIEDTIME": "2023-06-05 15:09:33:881",
"CREATEDTIME": "2023-06-05 15:09:33:881",
"ROWID": "3376000001927682",
"EmpID": "1002",
"EmpName": "James Cortez",
"Department":"HR",
"Address": "25, Blossom Street, Austin, TX"
}
},
{
"EmpDetails": {
"CREATORID": "3376000000002003",
"MODIFIEDTIME": "2023-06-02 21:04:11:111",
"CREATEDTIME": "2023-06-02 15:05:21:001",
"ROWID": "3376000001224112",
"EmpID": "1003",
"EmpName": "Han Chan",
"Department":"Sales",
"Address": "112, St.Patrick's Road, Louisville, KY"
}
},
{
"EmpDetails": {
"CREATORID": "337600000003111",
"MODIFIEDTIME": "2023-06-02 21:04:11:111",
"CREATEDTIME": "2023-06-02 15:05:21:001",
"ROWID": "3376000001242012",
"EmpID": "1004",
"EmpName": "Rubella Miguel",
"Department":"Accounts",
"Address": "333, Marine Bay, Salt Lake City, UT"
}
},
{
"EmpDetails": {
"CREATORID": "3376000000115254",
"MODIFIEDTIME": "2023-04-12 21:04:10:521",
"CREATEDTIME": "2023-06-11 15:05:02:541",
"ROWID": "3376000001241341",
"EmpID": "1005",
"EmpName": "Ronwick Boseman",
"Department":"Support",
"Address": "61, Gringott's Avenue, Herfordshire, CO"
}
}
]
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/query
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57
-H “Content-Type: application/json”
-d ‘{
“query”:“INSERT INTO EmpDetails VALUES (1007,‘Randy Marsh’,‘Sales’,‘42, Tenth Street, Jacksonville, FL’, ‘14 MAR 2017’)”
}’
{
"status": "success",
"data": [
{
"EmpDetails": {
"CREATORID": "3813000000002003",
"EmpID": "1007",
"EmpName": "Randy Marsh",
"Department":"Sales",
"Address": "42, Tenth Street, Jacksonville, FL",
"DOJ": "14 MAR 2017",
"MODIFIEDTIME": "2021-08-04 09:10:14:752",
"CREATEDTIME": "2021-08-04 09:10:14:752",
"ROWID": "3813000000214001"
}
}
]
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/query
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57
-H “Content-Type: application/json”
-d ‘{
“query”:“UPDATE EmpDetails SET Department=‘Operations’ WHERE EmpID=1007”
}’
{
"status": "success",
"data": [
{
"EmpDetails": {
"CREATORID": "3813000000002003",
"EmpID": "1007",
"EmpName": "Randy Marsh",
"Department":"Operations",
"Address": "42, Tenth Street, Jacksonville, FL",
"DOJ": "14 MAR 2017",
"MODIFIEDTIME": "2021-08-04 09:11:54:318",
"CREATEDTIME": "2021-08-04 09:10:14:752",
"ROWID": "3813000000214001"
}
}
]
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/query
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57
-H “Content-Type: application/json”
-d ‘{
“query”:“DELETE FROM EmpDetails WHERE EmpID=1007”
}’
{
"status": "success",
"data": [
{
"EmpDetails": {
"DELETED_ROWS_COUNT": 1
}
}
]
}
Yes
No
Thank you for your feedback!
Send your feedback to us