These APIs help you perform different tasks with the records of the application. The various Record APIs are as follows:
Name | Description |
formName | Link name of the form to which the records to be added. Refer this page to view and change the link name. |
data | Form data in json format, where the format for all the fields has been specified here. |
appName | Link name of the application from which data needs to be pushed to. |
Example :
-
//configuration json
-
var config = {
-
appName : "zylker",
-
formName : "timesheet",
-
data : formData
-
}
-
//add record API
-
ZOHO.CREATOR.API.addRecord(config).then(function(response){
-
if(response.code == 3000){
-
console.log("Record added successfully");
-
}
-
});
Form data :
-
formData = {
-
"data" : {
-
"Name": {
-
"first_name": "James",
-
"last_name": "Kyle",
-
},
-
"Address": {
-
"address_line_1": "Dari Mart",
-
"address_line_2": "Hayden Bridge Rd",
-
"district_city" : "Springfield",
-
"state_province" : "Oregon",
-
"postal_code" : "97477",
-
"country" : "United States"
-
},
-
"Rich_Text" : "The phone number is <b>+1541-726-4051</b>",
-
"Phone_Number": "+15417264051",
-
"Single_Line": "A simple one line text",
-
"Email": "
james@zylker.com
",
-
"Dropdown" : "Open",
-
"Radio" : "Closed",
-
"Multi_Select" : ["New", "Used"],
-
"Checkbox" : ["Refurbished", "Used"],
-
"Number": "1000",
-
"Decimal" : "1000.00",
-
"Percent": "60.00",
-
"Date_field" : "10-Jan-2020",
-
"Date_Time" : "23-Mar-2020 12:25:43 PM",
-
"Image" : "
https://www.zylker.com/sites/default/profile-01.jpg",
-
"Ur1": {
-
"value": "Dari Mart",
-
"url": "
www.darimart.com",
-
"title": "Dari mart provisional store"
-
},
-
"Lookup_Single_Select" : "521270000078464",
-
"Lookup_Multi_Select" : ["5212750000247932","5212750000564867"],
-
"SubForm" : [
-
{
-
"Single_Line" : "Service Equipment",
-
"Dropdown" : "New Order"
-
},
-
{
-
"Single_Line" : "Rotary Machine",
-
"Dropdown" : "Replacement",
-
}
-
]
-
}
-
}
Response :
Name | Description |
reportName | Link name of the report through which the record to be updated. Refer here to get and update the link name of a report |
id | ID value of the record to be updated |
data | Form data in json format, where format for all the fields have been specified here |
appName | Link name of the application in which data needs to be updated. |
Name | Description |
reportName | Link name of the report through which the record to be updated. Refer here to get and update the link name of a report |
criteria (optional) | Condition to filter the record, which is applied along with the condition specified in the report filter. The criteria must be specified in the following format is the link name of the field, which compares with the and the comparison is based on the . The supported operators are !=, <=, >=,<, >, == You can combine more than one criteria using logical AND (&&) and logical OR(||) Example : (Stage == "Open" && Score > 40) |
page (optional) | Index or number of the page to be retrieved. The default page number is 1 |
pageSize (optional) | Total number of records to be retrieved in the specified page. The default size is 100 and the maximum size is 200 |
appName | Link name of the application from which data needs to be pulled from. |
Name | Description |
reportName | Link name of the report through which the record to be updated. Refer here to get and update the link name of a report |
id | ID value of the record to be retrieved |
appName | Link name of the application from which data needs to be pulled from. |
Name | Description |
reportName | Link name of the report for which the record count is required. Refer here to get and update the link name of a report |
appName | Link name of the application from which data needs to be pulled from and counted. |
criteria (optional) | Condition to filter the record, which is applied along with the condition specified in the report filter. The criteria must be specified in the following format is the link name of the field, which compares with the and the comparison is based on the . The supported operators are !=, <=, >=,<, >, == You can combine more than one criteria using logical AND (&&) and logical OR(||) Example : (Stage == \"Open\" && Score > 40) |
Response:
Name | Description |
reportName | Link name of the report through which the record to be updated. Refer here to get and update the link name of a report |
criteria |
Condition to filter the record, which is applied along with the condition specified in the report filter. The criteria must be specified in the following format
<Field Name> <Operator> <Value> <Field name> is the link name of the field, which compares with the<Value> and the comparison is based on the <Operator>. The supported operators are !=, <=, >=,<, >, == You can combine more than one criteria using logical AND (&&) and logical OR(||) Example : (Stage == "Open" && Score > 40) |
appName | Link name of the application from which data needs to be deleted. |
Name | Description |
reportName | Link name of the report through which the record to be updated. Refer here to get and update the link name of a report |
id | ID value of the record where the file to be uploaded |
fieldName |
Link name of the field to which the file has to be uploaded. Refer here to get the link name of the field. The allowed field types are Image, Signature, File Upload, Audio, and Video. In case the file has to be uploaded to a field which has been added inside a subform, the fieldName will be subform field link name followed by the field link name of the field to be uploaded with (dot) in between. Example: ${SUBFORMFIELDNAME.FIELDNAME} |
fiel | It is a javascript File object to be uploaded. Refer here to know more about javascript File API |
parentId | In case the file has to be uploaded to a field which has been added inside a subform, then the parentId is the ID value of the parent record, i.e the main form record in which the subform has been embedded. |
appName | Link name of the application in which data needs to be uploaded. |
Note: The file can be uploaded only after submitting a record and this API will upload one file to one field at a time. In case of more number of fields in a form, this API need to call for each field separately.
Syntax
:
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.