Every record created has a unique ID. If you know a record's ID, you can pull all of its information by using the zoho.fsm.getRecordById() deluge task. Using this task, you can obtain the record's information in JSON format.
Syntax
| Method Used | Syntax |
| Using the Internal Connection | <Response> = zoho.fsm.getRecordById(<module>, <NUMBER>); |
| Using the Connection of a Service (Default/Custom) | <Response> = zoho.fsm.getRecordById(<module>, <NUMBER>, <optionalDataMap>, <connection>); |
where,
<Response> is the task response returned as a Map.
<module> is the API name of the module from which you want to fetch records
<NUMBER> is the unique ID of the record you want to retrieve.
<optionalDataMap> is a Map parameter to pass any additional values
<connection> is the connection created for Zoho FSM
Example
Retrieve a Request record with ID 865000000090254.
- //Use the below line of code if using the internal connection
- resp = zoho.fsm.getRecordById("Requests", "865000000090254");
- //Use the below line of code if using the connection of a service (default/custom)
- resp = zoho.fsm.getRecordById("Requests",865000000090254,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":"REQ6","Last_Activity_Time":null,"Work_Orders":[],"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":"865000000090254","Service_Address_Name":"Service address","Status":"New","Grand_Total":null,"Territory":{"name":"Fillmore","id":"865000000076023"},"Billing_Street":"Locust St","Created_Time":"2021-09-27T16:31:47-07:00","Priority":"Medium","$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":null,"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-27T16:31:47-07:00","Due_Date":null,"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":"Sample","Billing_Latitude":39.286597,"Service_Longitude":-89.108759,"Tag":null}]}