Get Records

The get records deluge task is used in integration scripts to get the list of records in a database for a specified criteria value. This criteria can be specified with the help a combination of operators. The get records by ID task can be used to get details of a particular record based on record ID. 

next_token: This token is returned in the JSON response of the getRecords task, if there are any remaining records and can be used to pull the next set of records from the database. 

The zoho.cliq.getRecords deluge task can be used with the following parameters in the query_map:

Sample syntax using criteria

query_map = Map(); 
criteria_string="field_name==field_value"; 
query_map.put("criteria",criteria_string); 
response_map=zoho.cliq.getRecords("<database_name>", query_map); 

Sample syntax with criteria and sort by order_by

query_map = Map(); 
criteria_string="field_name==field_value"; 
query_map.put("criteria",criteria_string); 
//To sort a column in a database in ascending order use  
query_map.put("order_by","+ field name"); 
//To sort a column in a database in descending order use
query_map.put("order_by","- field name");
response_map=zoho.cliq.getRecords("<database_name>", query_map); 

where,

• criteria_string = criteria with which the records will be fetched from a particular database
• criteria = key value for which the criteria_string should be passed

Operators 

While it is always easy to filter out records with parameters, it is important to use operators or filters to get finer results. Operators can be used to fetch a list of records that satisfy one or more conditions. 

First, let's start by creating a sample database to store attendee information for Conference XYZ. This database contains the following fields

• Name
• Age
• Role
• Country 

Query Criteria Types 

The list of criteria conditions that can be used to query records from a database are listed in the table below. 

Example

Let us consider creating a /myrequests command which will get the list of all requests raised by you. The userID of the user executing the command is passed as the criteria, to get the list of all records raised by the user.

response = Map();

// Define a criteria according to which the list of records must be fetched using the zoho.cliq.getRecords deluge task
query_map = Map(); 
criteria_string="userid=="+user.get("id"); 
query_map.put("criteria",criteria_string); 
response_map=zoho.cliq.getRecords("zylkerrequestmanagement", query_map); 
if(response_map.get("status").equalsIgnoreCase("SUCCESS") && response_map.get("list").size()>0)
{ 
    requestList = response_map.get("list"); 
} 
info response_map;
info requestList;

// Iterate the record list to display them in a tabular format in the message card. 

rows = List();
for each responseItem in requestList
{
row = Map();
row.put("Request ID",responseItem.get("id"));
row.put("Request", responseItem.get("request"));
row.put("Assignee", responseItem.get("assignedto") );
row.put("Status", responseItem.get("status"));
row.put("Delete Request", "[Delete Request](invoke.function|deleterecord|scott.fisher@zylker.com|"+responseItem.get("id")+")");
rows.add(row);
}
table = {"type":"table","title":"Usage Trend","data":{"headers":{"Request ID","Request","Assignee","Status"},"rows":rows}};
response = {"text":"These are the list of requests raised by you : ","card":{"theme":"modern-inline","title":"Your IT requests"},"slides":{table}};
return response;

A user executes the /myrequest command to view the list of requests raised and the status of the request. 

​

Get a record by id

The getRecordById deluge task is used in integration scripts to get the details of a particular record based on the record ID. 

Syntax

record_id="123456789"; 
response_map=zoho.cliq.getRecordById("<database_name>", record_id);

where,

• database_name = Name of the database
• record_id = Unique ID assigned to a particular record.