Método getRelatedRecords
Índice
Finalidad
Puede utilizar el método getRelatedRecords para capturar los registros relacionados.
Por ejemplo, puede capturar los clientes potenciales relacionados con una campaña o capturar las tareas relacionadas con una cuenta.
Dirección URL de la solicitud
Formato XML:
https://crm.zoho.com/crm/private/xml/Leads/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=Record ID&parentModule=Module Name
Formato JSON:
https://crm.zoho.com/crm/private/json/Leads/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=Record ID&parentModule=Module Name
Parámetros de la solicitud
| Parámetro | Tipo de datos | Descripción |
| authtoken* | Cadena | Cadena alfanumérica cifrada para autenticar sus credenciales de Zoho. |
| scope* | Cadena | Especifique el valor como crmapi |
| parentModule* | Cadena | Módulo del que desea capturar los registros relacionados Ejemplo: si desea capturar los clientes potenciales relacionados con una campaña, deberá seleccionar Campañas como el módulo principal. |
| ID* | Entero | El ID del registro del que desea capturar los registros relacionados |
| newFormat | Entero | newFormat=1: para excluir campos con valores "null" durante el ingreso de datos de su cuenta de CRM. newFormat=2: para incluir los campos con valores "null" durante el ingreso de datos de su cuenta de CRM. |
| fromIndex | Entero | Valor predeterminado: 1 |
| toIndex | Entero | Valor predeterminado: 20 Valor de rango máximo: 200 [Valor de rango máximo = toIndex - fromIndex] |
*: parámetro obligatorio
Nota:
- El método getRelatedRecords no admite campos de búsqueda personalizada.
Listas relacionadas compatibles
El método getRelatedRecords admite todos los módulos y sus respectivas listas relacionadas, excepto Correos electrónicos, Competidores e Integraciones (Zoho Support, Zoho Projects, etc.)
Ejemplos
Para capturar clientes potenciales relacionados con una campaña (con ID 121212121)
Formato de la dirección URL:
https://crm.zoho.com/crm/private/json/Leads/getRelatedRecords?newFormat=1&authtoken=sbdjEDBDJ1323&scope=crmapi&parentModule=Campaigns&id=121212121
Para capturar el historial por etapas relacionado con un acuerdo
Formato de la dirección URL:
https://crm.zoho.com/crm/private/xml/PotStageHistory/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=468939000000054013&parentModule=Deals
Para capturar funciones de los contactos relacionados con un acuerdo
Formato de la dirección URL:
https://crm.zoho.com/crm/private/xml/ContactRoles/getRelatedRecords?authtoken=Auth Token&scope=crmapi
&id=468939000000054013&parentModule=Deals
Para ver los archivos adjuntados a un registro
Formato de la dirección URL:
https://crm.zoho.com/crm/private/xml/Attachments/getRelatedRecords?authtoken=Your Auth Token&newFormat=1&scope=crmapi&parentModule=Leads&id=508020000000957321
Ejemplo de respuesta
Para capturar las notas de un registro
Formato de la dirección URL:
https://crm.zoho.com/crm/private/xml/Notes/getRelatedRecords?authtoken=<Your Authtoken>&scope=crmapi&id=RECORD_ID&parentModule=Module Name