COQL - CRM Object Query Language

CRM Object Query Language (COQL) é uma linguagem de consulta baseada na sintaxe SQL. Ajuda os usuários a escrever suas próprias consultas para obter registros do Zoho CRM usando nomes de API de campo em vez de nomes de coluna e nomes de API de módulo em vez de nomes de tabela.

Características

• COQL suporta apenas a consulta SELECT com as cláusulas WHERE, FROM, ORDER BY, LIMIT e OFFSET
• As palavras-chave COQL não diferenciam maiúsculas de minúsculas
• Por padrão, o sistema classifica os registros em ordem crescente com base no ID do registro
• O valor padrão para LIMIT é 200 e OFFSET é 0

Vantagens do COQL

• Baseado na sintaxe SQL, muito simples de usar
• Não precisa criar visualizações personalizadas
• Ampla gama de possibilidades de pesquisa
• Limite de até 200 registros por consulta
• Fácil relacionar dois módulos usando campos de pesquisa

Limitações

• Máximo de 200 registros por consulta
• Apenas Select query é suportada
• Máximo de duas relações (junções) por consulta
• Máximo de 25 critérios na cláusula WHERE
• Máximo de 50 colunas na seleção

Comparadores Suportados

• = (igual)
• > (maior que)
• < (menos que)
• >= (maior ou igual)
• <= (menor ou igual)
• is null e is not null
• between and
• in e not in
• like (starts_with, ends_with, contains)
• not like (not_contains)

Exemplo

querymap = Map();
querymap.put("select_query", "select Last_Name, First_Name, Full_Name from Contacts");
requisicao = invokeurl
[
    url :"https://www.zohoapis.com/crm/v2/coql"
    type :POST
    parameters: querymap.toString()
    connection : "coql"
];
info requisicao;

Importante: Embora você "obtenha" registros do módulo, o método HTTP é POST quando você "publica" a consulta.