A tarefa getRecods é usada para buscar registros do módulo Zoho CRM especificado.
Sintaxe
<variável> = zoho.crm.getRecords (<module_name>, < page > ,< per_page>,<query_value>,<connection>);
- <variável> é a resposta retornada pelo Zoho CRM apresenta os registros de valores buscados em relação aos nomes de API de seus respectivos campos.
- <module_name>nome da API do módulo Zoho CRM de onde os registros serão obtidos
- <page> usado para obter a lista de registro com base nas páginas
- <per_page> usado para obter a lista de registros disponíveis por página, valor padrão 200
- <query_value> usado para conter os outros parâmetros especificados na API Zoho CRM
- <connection> o nome da conexão
Get Records API
Um registro pode armazenar todas as informações combinadas de um determinado contato ou empresa. A API de registro permite ao usuário obter, criar, atualizar, excluir ou pesquisar registros, tem como maior objetivo obter a lista de registro disponíveis de um módulo.
Parâmetros
fields
Usado para recuperar valores de campos específicos.
Valores possíveis: nomes de API de campos separados por vírgulas.
Exemplo: Last_Name,Email
ids
Usado para recuperar registros específicos com base em seu ID exclusivo.
Valores possíveis: IDs únicos válidos de registro
Exemplo: 4150868000001944196
sort_order
Usado para classificar a lista de registros em ordem crescente ou decrescente.
Valores possíveis: asc – ordem crescente; desc – ordem decrescente
sort_by
Especifique o nome da API do campo com base no qual os registros devem ser classificados.
Valores possíveis: nomes de API de campo.
Exemplo: Email
converted
Usada para recuperar a lista de registros convertidos. O valor padrão é false
Valores possíveis: true – obtém apensa registros convertidos; false – obtém somente registros não convertidos; all – obtém todos registros
approved
Usado para recuperar a lista de registros aprovados. O valor padrão é true
Valores possíveis: true – obtém apenas registros aprovados; false – obtém apenas registros que não foram aprovados; both – obtém todo registros
page
Usado para obter uma lista de registros das respectivas páginas. o valor padrão da página é 1.
Valores possíveis: apenas valores inteiros positivos.
per_page
Usado para obter a lista de registros disponíveis por página. O valor padrão e máximo possível é 200.
Valores possíveis: apenas valores inteiros
cvid
Usado para obter lista de registros em uma visualização personalizada.
Valores possíveis: {custom_view_id} que você pode obter usando a API de metadados de visualização personalizada.
territory_id
Para obter a lista de registro em um território.
Valores possíveis: {territory_id} que você pode obter usando a API de território .
include_child
Usado para incluir registros dos territórios filhos. O padrão é false.
Valores possíveis: true – inclui registros de território filho; false – não inclui registro de território filho
Buscar registro de módulos específicos
lista = Map(); //variável que contém os parâmetros de consulta
lista.put("sort_order","asc"); // classifica o registro em ordem crescente
lista.put("sort_by","First_Name "); /* nome da API no qual o registro deve ser
clasificado*/
registro = zoho.crm.getRecords("Contacts", 1, 5, lista); /*variável que conterá a
resposta retornada pelo Zoho CRM. Ele contém os registros obtidos do módulo de contatos
do Zoho CRM.*/
info registro;
A busca acima foi criada uma variável de map que contém os parâmetros de consultam, a mesma retorna em ordem crescente o primeiro nome de contatos, no índice 1, número de registros que serão buscados 5.
Buscar dados de um módulo personalizado
registro = zoho.crm.getRecords("Contacts", 1, 5);
info registro;
A busca acima obtém registro personalizado do Zoho CRM – Contacts
<registro> variável que conterá resposta do Zoho CRM
<getRecords> bucar registro em um módulo especificado
<Contacts> módulo especifico no CRM
<1> índice do primeiro registro que será buscado
<5> número de registro que serão buscados