Fetch records
You can fetch records from a module using the zoho.fsm.getRecords() deluge task.
Syntax
Method Used | Syntax |
| Using the Internal Connection | <Response> = zoho.fsm.getRecords(<module>); |
Using the Connection of a Service (Default/Custom) | <Response> = zoho.fsm.getRecords(<module>, <page>, <perPage>, <optionalDataMap>, <connection>); |
where,
<Response> is the task response returned as a List.
<module> is the API name of the module from which you want to fetch records
<page> indicates the page number from which you want to retrieve records. The default value is 1
<perPage> specifies the number of records that need to be fetched per page. The default value is 200.
<optionalDataMap> is a Map parameter to pass any additional values
<connection> is the connection created for Zoho FSM
Example
Retrieve records from the Request module.
- //Use the below line of code if using the internal connection
- resp = zoho.fsm.getRecords("Requests");
- //Use the below line of code if using the connection of a service (default/custom)
- resp = zoho.fsm.getRecords("Requests",1,20,Map(), "fsmconnection");
- info resp;
Response Format
{"data":[{"Origin":null,"Owner":{"name":"Tracy Pollan","id":"865000000070001","email":"test@gmail.com"},"Company":{"name":"Nebula","id":"865000000079001"},"Email":"test@gmail.com","$currency_symbol":"$","Customer":{"name":"Joe Molinaro","id":"865000000079009"},"Preferred_Date":null,"Name":"REQ3","Last_Activity_Time":"2021-09-27T10:48:58-07:00","Preferred_End_Time":null,"Invalid_Data":false,"Billing_Longitude":-89.107787,"Unsubscribed_Mode":null,"Exchange_Rate":1,"Close_Time":null,"Cancellation_Message":null,"Billing_Country":"United States","Currency":"USD","Asset":null,"id":"865000000086031","Service_Address_Name":"Service address","Status":"New","Grand_Total":null,"Territory":{"name":"Fillmore","id":"865000000076023"},"Billing_Street":"Locust St","Created_Time":"2021-09-23T00:06:44-07:00","Priority":"Critical","$editable":true,"Billing_City":"Oconee","Preference":null,"Service_Zip_Code":"62553","Service_Street":"10 Oak St","Created_By":{"name":"Tracy Pollan","id":"865000000070001","email":"test@gmail.com"},"Service_Country":"United States","Preferred_Start_Time":null,"Service_Latitude":39.287425,"Cancellation_Reason":null,"Config":"{\"sales_tax_type\":\"exclusive\",\"Type\":\"32\",\"is_discount_before_tax\":true,\"is_inclusive_tax\":false,\"is_discount_tax_inclusive\":false,\"isBlueprint\":\"simple\",\"discount_type\":\"entity_level\",\"is_sales_inclusive_tax_enabled\":false,\"Tax_Details\":{\"Tax_Percentage\":6.25,\"Tax_Id\":\"2849027000000074101\",\"taxFromModule\":\"Addresses\",\"Tax_Name\":\"IllinoisSalesTax\",\"Taxable\":true}}","Reported_By":null,"Billing_Street2":null,"Dispatcher":{"name":"Pollan","id":"865000000070001"},"Preferred_Slot":"Weekdays","Record_Image":null,"Modified_By":{"name":"Tracy Pollan","id":"865000000070001","email":"test@gmail.com"},"Phone":"6564352341","Service_Address":{"name":"AD-4","id":"865000000079012"},"Billing_Address_Name":"Billing address","Service_City":"Oconee","Modified_Time":"2021-09-27T10:48:58-07:00","Due_Date":"2021-09-23","Service_State":"Illinois","Unsubscribed_Time":null,"Service_Street2":null,"Completed_Time":null,"Work_Order":null,"Estimate_Required":false,"Billing_Address":{"name":"AD-3","id":"865000000079011"},"Billing_State":"Illinois","Billing_Zip_Code":"62553","Summary":"AC Installation","Billing_Latitude":39.286597,"Service_Longitude":-89.108759,"Tag":null}],"info":{"per_page":20,"count":3,"page":1,"more_records":false}}
Access your files securely from anywhere
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
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.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho Writer?
Create. Review. Publish.
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
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.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Add records
You can create records using the zoho.fsm.createRecord() deluge task. Syntax Method Used Syntax Using the Internal Connection <Response> = zoho.fsm.createRecord(<module>, <KEY-VALUE>); Using the Connection of a Service (Default/Custom) <Response> = ...Updating Records
You can update a record of a module using the zoho.fsm.updateRecord() deluge task. Syntax Method Used Syntax Using the Internal Connection <Response> = zoho.fsm.updateRecord(<module>, <NUMBER>, <KEY-VALUE>); Using the Connection of a Service ...Getting Related Records
You can fetch related information (Notes, Tasks, Contacts, etc.) about a record using the zoho.fsm.getRelatedRecords() deluge task. Syntax Method Used Syntax Using the Internal Connection <Response> = zoho.fsm.getRelatedRecords(<relationName>, ...Merge Records
In Zoho FSM you can easily eliminate duplicate records. While syncing data with external systems (e.g. Zoho Invoice/Books), or importing external data, there are chances of duplicate records getting added to Zoho FSM. In this case, you might want to ...Revert Status of Records
You can revert the status of cancelled or terminated work orders and service appointment records back to their previous state. You can also revert a completed service appointment. Permission Required: Revert To revert the status of a record: Click ...
New to Zoho LandingPage?
Zoho LandingPage Resources