A tarefa getRecords é usada para buscar registros do módulo Zoho CRM especificado.
Sintaxe
<variável> = zoho.crm.getRecords(<module_name>, <page>, <per_page>, <query_value>, <connection>);
Parâmetros
- <variável> - Resposta retornada pelo Zoho CRM com os registros buscados
- <module_name> - Nome da API do módulo de onde os registros serão obtidos
- <page> - Usado para obter a lista de registro com base nas páginas
- <per_page> - Número de registros por página (valor padrão: 200)
- <query_value> - Parâmetros extras da API
- <connection> - Nome da conexão
Parâmetros de Consulta
- fields - Recuperar valores de campos específicos. Exemplo: Last_Name,Email
- ids - Recuperar registros específicos por ID
- sort_order - Ordenar em asc (crescente) ou desc (decrescente)
- sort_by - Nome da API do campo para ordenação
- converted - Filtrar por registros convertidos (true/false/all)
- approved - Filtrar por registros aprovados (true/false/both)
Exemplo - Buscar com Parâmetros
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
classificado */
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;
Exemplo Simples
registro = zoho.crm.getRecords("Contacts", 1, 5);
info registro;
Nota: A busca obtém registros do módulo Contacts do Zoho CRM. O <1> é o índice do primeiro registro e <5> é o número de registros que serão buscados.