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>, <parentModuleName>, <id>); |
Using the Connection of a Service (Default/Custom) | <Response> = zoho.fsm.getRelatedRecords(<relationName>, <parentModuleName>, <id>, <page>, <perPage>, <optionalDataMap>, <connection>); |
where,
<Response> is the task response returned as a List.
<relationName> is the API name of the related list whose entries you want to fetch.
<parentModuleName> is the API name of the module whose related list information you want to fetch.
<id> is the unique ID of the parent record whose related list information you want to fetch.
<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
Fetch the Work Orders related to the Request record with ID 865000000079025.
- info zoho.fsm.getRelatedRecords("Work_Orders", "Requests", "865000000079025", 1,20, Map());
Response Format
{"data":[{"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,"Place_of_Supply":null,"Name":"WO1","Last_Activity_Time":"2021-09-21T09:24:59-07:00","Preferred_End_Time":"2021-09-21T11:00:00-07:00","Invalid_Data":false,"Billing_Longitude":-89.107787,"Unsubscribed_Mode":null,"Exchange_Rate":1,"Cancellation_Message":null,"Close_Time":null,"Billing_Country":"United States","Currency":"USD","Asset":null,"id":"865000000079093","Service_Address_Name":"Service address","Status":"In Progress","Grand_Total":486.11,"Territory":{"name":"Fillmore","id":"865000000076023"},"Billing_Street":"Locust St","Created_Time":"2021-09-20T04:41:16-07:00","Priority":"Medium","$editable":true,"Parent_Work_Order":null,"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":"2021-09-20T10:00:00-07:00","Service_Latitude":39.287425,"Estimate":{"name":"ES1","id":"865000000079062"},"Cancellation_Reason":null,"Config":"{\"Tax_Details\":{\"Tax_Percentage\":6.25,\"Tax_Id\":\"2849027000000074101\",\"taxFromModule\":\"Addresses\",\"Tax_Name\":\"IllinoisSalesTax\",\"Taxable\":true}}","Billing_Street2":null,"Dispatcher":{"name":"Tracy Pollan","id":"865000000070001"},"Preferred_Slot":"Preferred Time","Record_Image":null,"Modified_By":{"name":"Tracy Pollan","id":"865000000070001","email":"test@gmail.com"},"Phone":"6564352341","Billing_Address_Name":"Billing address","Service_Address":{"name":"AD-4","id":"865000000079012"},"ZCRM_Id":null,"Service_City":"Oconee","Modified_Time":"2021-09-21T09:24:59-07:00","Due_Date":"2021-09-20","Service_State":"Illinois","Unsubscribed_Time":null,"Request":{"name":"REQ1","id":"865000000079025"},"Service_Street2":null,"Completed_Time":null,"Type":"Service","Billing_Address":{"name":"AD-3","id":"865000000079011"},"Billing_State":"Illinois","Billing_Zip_Code":"62553","Summary":"Bathroom Plumbing","Billing_Latitude":39.286597,"Service_Longitude":-89.108759,"Tag":null}],"info":{"per_page":20,"count":1,"page":1,"more_records":false}}