Query COQL API

Query COQL API

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.

Você pode usar esta API para filtrar e buscar registros com base em determinados critérios, em vez de criar visualizações personalizadas e passar esse cvid (ID de visualização personalizada) como um parâmetro em sua solicitação. Usando esta API, você pode recuperar no máximo 200 registros .

  • 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 . SELECT é o mesmo que select.

  • Por padrão, o sistema classifica os registros em ordem crescente com base no ID do registro , se você não incluir ordem por na consulta.

  • O valor padrão para LIMIT é 200 e OFFSET é 0 .

Vantagens do COQL

  • COQL é baseado na sintaxe SQL e é muito simples de usar.

  • Não há necessidade de criar visualizações personalizadas com base em certos critérios e passar esse cvid na solicitação. Em vez disso, você pode usar a consulta COQL Select com diferentes comparadores diretamente na entrada para buscar registros que correspondam aos critérios.

  • Os comparadores de COQL com suporte cobrem uma ampla gama de possibilidades de pesquisa. Por exemplo, você pode usar o comparador in para pesquisar registros em uma lista de valores, o que não é possível usando a API Search Records.

  • A cláusula limit permite que você defina o número de registros que deseja buscar. Você pode buscar no máximo 200 registros usando esta API.

  • Fácil de juntar ou relacionar dois módulos com a ajuda de campos de pesquisa usando . (Ponto)

  • Não há necessidade de especificar o alias do módulo explicitamente ao estabelecer uma relação entre dois módulos, pois os nomes da API são exclusivos para cada módulo.

Limitações do COQL

  • Você pode buscar no máximo 200 registros usando esta API.

  • Você pode usar apenas Selecionar consulta em COQL para obter registros de um módulo.

  • Você pode usar no máximo duas relações (junções) em uma consulta de seleção para obter os registros de um módulo.

  • Se você usar mais de duas relações em uma consulta selecionada, o sistema valida apenas as duas últimas relações.

  • O usuário deve ter os escopos necessários para acessar o módulo básico.

  • Apenas os seguintes comparadores (destacados em negrito) são suportados em COQL:

    • = (igual)

    • > (maior que)

    • < (menos que)

    • > = (maior ou igual)

    • <= (menor ou igual)

    • is null

    • is not null

    • between and

    • not in

    • like (usado apenas para começa_com, termina_com e contém)

    • not like (usado para not_contains)

  • Os critérios especificados na cláusula WHERE devem ser colocados corretamente entre colchetes para evitar ambiguidade. Se WHERE tiver mais de dois critérios, como A, B e C, use-os como (A e (B e C)) ou ((A e B) e C) .

  • Você não pode usar campos multilinhas, como “Descrição”, “Termos e Condições”, “Comentários” etc., nos critérios.

  • Você pode incluir no máximo 25 critérios na cláusula WHERE .

  • Você pode usar no máximo 50 colunas , ou seja, 50 field_API_names na coluna de seleção da consulta. Exemplo: Selecione First_Name, Last_Name, Full_Name … até 50 field_API_names.

O seguinte não é compatível com COQL:

  • Campos de território

  • Módulo de subformulário e campos de subformulário

  • Módulos de ligação

  • Campos de pesquisa multi-seleção

  • Itens de linha (Pricing_Details e Product_Details) nos módulos de catálogos de preços e cotações

  • Campo de participantes no módulo de eventos

  • Campos de upload de arquivo

  • Tag

  • Notas

  • Anexos

 Cbter os registros do módulo por meio de uma consulta COQL.

Solicitar URL

https://www.zohoapis.com/crm/v2/coql

Cabeçalho

Autorização: Zoho-oauthtoken d92d4xxxxxxxxxxxxxxx15f52

Escopo

scope = ZohoCRM.coql.READ
(and)
scope = ZohoCRM.modules.all
(ou)
scope = ZohoCRM.modules. {module_name}. {operation_type}

Nomes de módulos possíveis

leads, contas, contatos, negócios, campanhas, tarefas, casos, eventos, chamadas, soluções, produtos, fornecedores, pricebooks, cotações, vendas, ordens de compra, faturas e personalizado

Possíveis tipos de operação

TODOS – Acesso total aos dados
READ – Obter dados do módulo

Observação

Embora você “obtenha” registros do módulo, o método HTTP é POST quando você “publica” a consulta. Consulte CRM Object Query Language (COQL) – Uma Visão Geral para aprender como construir uma consulta COQL.

Solicitar JSON

  • select_query chave JSON, obrigatória

    Representa que a entrada é uma consulta selecionada.

Texto, lista de seleção

= , ! = , like(usado para starts_with, ENDS_WITH, contém), not like (usado para not_contains), in, not in, is null, is not null.

Abaixo um exemplo de como utilizar o COQL

				
					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;

Deixe um comentário