Método getRecordById
Índice
Finalidade
Você pode usar esse método para recuperar registros individuais por ID de registro.
Solicitar URL
Formato XML:
https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&id=RecordID
Formato JSON:
https://crm.zoho.com/crm/private/json/Leads/getRecordById?&authtoken=Auth Token&scope=crmapi&id=RecordID
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 |
| id* ou idlist* | Sequência | id: Specify unique ID of the record. idlist: especifique o conjunto exclusivo de IDs (separados por ponto e vírgula). Você pode especificar até 100 IDs usando esse parâmetro. |
| newFormat | Inteiro (1 ou 2) | newFormat=1: Para excluir campos com valores "nulo" ao buscar dados de sua conta CRM.newFormat=2: Para incluir campos com valores "nulo" ao buscar dados de sua conta CRM. |
| versão | Número inteiro | versão = 1: (Valor padrão) Isso buscará respostas com base na implementação anterior de API, ou seja, antes que os aprimoramentos sejam feitos. versão = 2: Isso vai buscar respostas com base na implementação de API mais recente. |
* - Parâmetro obrigatório
Nota:
- Consulte a página Notas da versão para saber mais sobre os aprimoramentos feitos na implementação da API.
Exemplos
Para buscar registros por ID, use o URL especificado abaixo:
https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&id=ID
Para buscar registros por lista de ID, use o URL especificado abaixo:
https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&idlist=ID1;ID2;...;ID100
Nota:
- Você pode buscar registros usando o parâmetro id ou idlist. Use o parâmetro "id" para recuperar registros de um ID exclusivo. Use o parâmetro "idlist" para recuperar registros dos ID desejados.
Para buscar oportunidades sem especificar o parâmetro newFormat
Nota:
- Quando não houver especificação sobre o formato de resposta, o valor padrão "1" será atribuído ao parâmetro newFormat, ou seja, newFormat = 1
Isso retornará uma resposta como abaixo:
Para buscar oportunidades especificando o parâmetro idlist
Isso retornará uma resposta como abaixo:
Testar programa
Você pode usar o programa anexado para executar e testar o funcionamento do método getRecordById em seu ambiente Java.
O programa Java contém o seguinte:
- o formato de geração de token de autenticação
- os parâmetros e seus valores
- uso real do método
Clique aqui para baixar o programa