Método getCVRecords
Índice
- Finalidade
- Solicitar URL
- Parâmetros de solicitação
- Códigos de erro
- Exemplos
- Para buscar todas as oportunidades abertas pelo módulo Oportunidade
- Para buscar oportunidades sem especificar o parâmetro newFormat
- Para buscar com newFormat=2
- Para chamar com fromIndex=1, toIndex=25
- Para chamar com lastModifiedTime
- Para selecionar todos os campos das oportunidades com newFormat=1
- Para selecionar todos os campos das oportunidades com newFormat=2
- Para chamar com lastModifiedTime, fromIndex e toIndex
- Testar programa
Finalidade
Você pode usar o método getCVRecords para buscar dados em relação à exibição personalizada em Zoho CRM.
Importante: independentemente da edição do Zoho CRM, você pode enviar somente 250 solicitações de API/dia. Em cada solicitação, você pode buscar um máximo de 200 registros.
Solicitar URL
Formato XML:
https://crm.zoho.com/crm/private/xml/Leads/getCVRecords?authtoken=Auth Token&scope=crmapi&cvName=Nome da exibição personalizada
Formato JSON:
https://crm.zoho.com/crm/private/json/Leads/getCVRecords?authtoken=Auth Token&scope=crmapi&cvName=Nome da exibição personalizada
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 |
| fromIndex | Número inteiro | Valor padrão - 1 |
| toIndex | Número inteiro | Valor padrão - 20 Valor máximo - 200 |
| cvName* | Sequência | Buscar os dados para a exibição personalizada especificada. Exemplo: cvName=Todas as Oportunidades Abertas |
| lastModifiedTime | DateTime | Default:null Se você especificar o tempo, os dados criados/modificados serão pesquisados após o tempo configurado. |
| 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. |
| versão | Número inteiro | versão = 1: (Padrão) Isso buscará respostas com base na implementação anterior de API, ou seja, antes que os aprimoramentos sejam feitos. A versão atual é 4. |
* - Parâmetro obrigatório
Códigos de erro
Consulte Códigos de erro .
Exemplos
Para buscar todas as oportunidades abertas pelo módulo Oportunidade
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 mostrado abaixo:
O valor de E-mail é nulo e, portanto, ela não é mostrada na resposta.
Para buscar com newFormat=2
Isso retornará uma resposta como abaixo:
Para chamar com fromIndex=1, toIndex=25
Nota:
- Isso retornará os primeiros 25 registros.
Para chamar com lastModifiedTime
Nota:
- Se você especificar o tempo, os dados modificados serão pesquisados após o tempo configurado.
Para selecionar todos os campos das oportunidades com newFormat=1
Nota:
- Isso retornará todos os campos com valores.
Para selecionar todos os campos das oportunidades com newFormat=2
Nota:
- Isso retornará todos os campos, incluindo campos de valor nulo.
Para chamar com lastModifiedTime, fromIndex e toIndex
Testar programa
Você pode usar o programa anexado para executar e testar o funcionamento do método getCVRecords em seu ambiente Java. O programa Java contém o seguinte:
- o formato de geração de token
- os parâmetros e seus valores
- uso real do método
Clique aqui para baixar o programa.