Método getRelatedRecords
Finalidade
Você pode usar o método getRelatedRecords para buscar registros relacionados.
Por exemplo: você pode buscar oportunidades relacionadas a uma campanha ou buscar tarefas relacionadas a uma conta.
Solicitar URL
Formato XML:
https://crm.zoho.com/crm/private/xml/Leads/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=ID de registro&parentModule=Nome do módulo
Formato JSON:
https://crm.zoho.com/crm/private/json/Leads/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=ID de registro&parentModule=Nome do módulo
Parâmetros de solicitação
| Parâmetro | Tipo de dados | Descrição |
| authtoken* | Sequência | Sequências alfanuméricas criptografadas para autenticar suas credenciais do Zoho. |
| escopo* | Sequência | Especifique o valor como crmapi |
| parentModule* | Sequência | Módulo para o qual você deseja buscar os registros relacionados Por exemplo: se você deseja buscar oportunidades relacionadas a uma campanha, o módulo principal é Campanhas. |
| ID* | Número inteiro | O ID do registro para o qual deseja buscar os registros relacionados |
| newFormat | Número inteiro | newFormat=1:Para excluir campos com valores "nulos" ao inserir dados pela conta CRM. newFormat=2:Para incluir campos com valores "nulos" ao inserir dados pela conta CRM. |
| fromIndex | Número inteiro | Valor padrão - 1 |
| toIndex | Número inteiro | Valor padrão - 20 Valor máximo de intervalo - 200 [Valor máximo de intervalo = toIndex - fromIndex] |
* - Parâmetro obrigatório
Nota:
- O método getRelatedRecords não suporta campos de busca personalizada.
Listas relacionadas suportadas
O método getRelatedRecords oferece suporte a todos os módulos e suas respectivas listas relacionadas, exceto de e-mails, concorrentes e integrações (Zoho Support, Zoho Projects etc.)
Exemplos
Para buscar oportunidades relacionadas a uma campanha (com ID 121212121)
Formato do URL:
https://crm.zoho.com/crm/private/json/Leads/getRelatedRecords?newFormat=1&authtoken=sbdjEDBDJ1323&scope=crmapi&parentModule=Campaigns&id=121212121
Para buscar o histórico de estágios relacionados a uma negociação
Formato do URL:
https://crm.zoho.com/crm/private/xml/PotStageHistory/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=468939000000054013&parentModule=Negociações
Para buscar as funções de contato relacionadas a uma negociação
Formato do URL:
https://crm.zoho.com/crm/private/xml/ContactRoles/getRelatedRecords?authtoken=Auth Token&scope=crmapi
&id=468939000000054013&parentModule=Negociações
Para exibir arquivos anexados a um registro
Formato do URL:
https://crm.zoho.com/crm/private/xml/Attachments/getRelatedRecords?authtoken=Your Token de autenticação&newFormat=1&scope=crmapi&parentModule=Negociações&id=508020000000957321
Resposta da amostra
Para buscar notas em um registro
Formato do URL:
https://crm.zoho.com/crm/private/xml/Notes/getRelatedRecords?authtoken=<Your Authtoken>&scope=crmapi&id=RECORD_ID&parentModule=Nome do módulo