Fetch record By ID
Table of Contents
Note: This task is applicable to all Zoho Services except Zoho Creator.
Overview
This task is used to fetch a record using its ID from a Zoho Cliq database.
This task is based on Zoho Cliq API - Get Record.
Syntax
<variable> = zoho.cliq.getRecordById(<database_name>, <record_ID>, <connection>);
Parameter | Data type | Description |
<variable> | KEY-VALUE | specifies the variable which will hold the response returned by Zoho Cliq. |
<database_name> | TEXT | specifies the unique name of the database from which the record will be fetched. |
<record_ID> | NUMBER | specifies the ID of the record which will be fetched. Learn how to fetch the record ID after creating or fetching records. |
<connection> | TEXT | specifies the link name of the Zoho Cliq connection. Note:
|
Example
The following example fetches a record with ID - 1775XXXX0002XXXX009 from the database - availabilitydatabase.
response_map=zoho.cliq.getRecordById("availabilitydatabase", 1775XXXX0002XXXX009, "cliq_connection");
where,
response_map
"availabilitydatabase"
1775XXXX0002XXXX009
"cliq_connection"
Sample Response
Success Response
The success response returned is of the following format
{
"status":"SUCCESS",
"url":"/api/v2/storages/availabilitydatabase/records",
"object":{"empid":"1","name":"Hanna","availability":true,"id":"1775XXXX0002XXXX009"}
}
Failure Response
The failure response returned for an incorrect database name is of the following format
{
"status":"FAILURE",
"message":"Uh-oh! Looks like availabilitydata does not exist.",
"code":"platform_storage_database_not_found"
}The failure response returned for an incorrect record ID is of the following format
{
"status":"FAILURE",
"message":"No record found for this id",
"code":"platform_storage_record_not_exists"
}
Related Links
- Zoho Cliq API
- Common error codes can be viewed here