CRM Help

      Método getSearchRecords

      Índice

      Finalidade

      Você pode usar este método para pesquisar nos registros por expressões de colunas selecionadas.

      URL de solicitação

      Formato XML:
      https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi

      Formato JSON:
      https://crm.zoho.com/crm/private/json/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi

      Nota:

      • Independentemente do plano Zoho CRM, você só pode enviar 250 solicitações de API / dia. Em cada chamada, você pode buscar um máximo de 200 registros.

      Parâmetros de solicitação

      ParâmetroTipo de dadosDescrição
      authtoken*StringSequências alfanuméricas criptografadas para autenticar suas credenciais do Zoho.
      scope*StringEspecifique crmapi como scope
      selectColumns*StringModule(optional columns) ou seja, Leads(Last Name,Website,Email) OU All
      searchCondition*String(Criado por|=|nome do usuário)
      newFormatNúmero inteironewFormat=1: para excluir campos com valores "null", ao inserir dados de sua conta CRM.
      newFormat=2: para incluir campos com valores "null", ao inserir dados de sua conta CRM.
      fromIndexNúmero inteiroValor Padrão – 1
      toIndexNúmero inteiroValor padrão – 20
      Valor máximo – 200
      versionNúmero inteiroversion = 1: (valor padrão) Irá buscar respostas com base na implementação API anterior, ou seja, antes dos aprimoramentos feitos.
      version = 2: irá buscar respostas com base na implementação API mais recente.

      * – Parâmetro obrigatório

      Nota:

      • Consulte a página Notas de versão para saber mais sobre as melhorias feitas na implementação API.

      Expressões regulares

      Ao usar este método, certifique-se de que os parâmetros selectColumns e searchCondition estejam definidos como obrigatórios. Você pode especificar as seguintes expressões na solicitação de API:

      • is OR =
      • isn't OR <>
      • contains(*srcString*)
      • starts with(srcString*)
      • ends with(*srcString)
      • doesn't contain
      • < OR is before
      • > OR is after
      • <=
      • =>

      Exemplos

      Exemplo 1

      Se você quiser selecionar Lead Name,Company,Email,Mobile,Website de Leads e Email deve conter "@exemplo.com", a solicitação de pesquisa API deve ser como abaixo:

      https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Name,Company,Email,Mobile,Website)&searchCondition=(Email|contains|*@sample.com*)

      Exemplo 2

      Se você quer selecionar Company,Email,Website de Leads e Nº de empregados deve ser maior que 100, a solicitação de pesquisa API deve ser como abaixo:

      https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Company,Email,Website)&searchCondition=(No of Employees|>|100)

      Exemplo 3

      Se você quer selecionar Lead Name,Email de Leads e Company deve começar com "Zoho", a solicitação de pesquisa API deve ser como abaixo:

      https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Name,Email)&searchCondition=(Company|starts with|Zoho*)

      Exemplo com igual(=)

      https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
      &selectColumns=Leads(First Name,Last Name,Email,Company)&searchCondition=(Email|=|test@test.com)

      Exemplo com maior que(>)

      https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
      &selectColumns=Leads(First Name,Last Name,Email,Company)
      &searchCondition=(Annual Revenue|>|1000)

      Exemplo com menor que(<)

      Nota:

      • Substitua o valor null nos campos de número inteiro por "0". Os campos de número inteiro sem valor não serão incluídos na pesquisa.

      https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
      &selectColumns=Leads(First Name,Last Name,Email,Company)
      &searchCondition=(customfield1|<|1000)

      Exemplo com contém

      https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
      &selectColumns=Leads(First Name,Last Name,Email,Company)
      &searchCondition=(Company|contains|*oho*)

      Exemplo com começa com

      https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
      &selectColumns=Leads(First Name,Last Name,Email,Company)
      &searchCondition=(Company|starts with|zoho*)

      Exemplo com termina com

      https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
      &selectColumns=Leads(First Name,Last Name,Email,Company)
      &searchCondition=(Company|ends with|*zoho)

      Exemplo com igual(=) e selectColumns=All

      https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
      &selectColumns=All
      &searchCondition=(Email|=|test@test.com)

      Programa de teste

      Você pode usar o programa anexado para executar e testar o funcionamento do método getSearchRecords em seu ambiente de Java.

      O programa Java contém o seguinte:

      • O formato de geração do token de autenticação
      • Os parâmetros e seus valores
      • Uso real do método

      Clique aqui para fazer download do programa

      Share this post : FacebookTwitter

      Ainda não consegue encontrar o que você está procurando?

      Escreva para nós: support@zohocrm.com

       
       

      Links rápidos

             Inscreva-se gratuitamente Acesse Zoho crm
      Todo o produto zoho