View Categories

API REST – Solicitudes y consultas

2 minutes

Query — Consultar la base de datos #

Esta operación permite ejecutar una consulta SELECT. La consulta debe seguir un formato específico y presenta ciertas limitaciones:

  • Un solo tipo de entidad por consulta (sin JOIN)
  • Máximo 100 resultados por consulta (utilice LIMIT y OFFSET para paginar)
  • Las cláusulas WHERE, ORDER BY y LIMIT son opcionales
  • La consulta debe estar codificada en URL

GET https://apps.kafinea.com/{instance}/webservice.php

Parámetro Tipo Obligatorio Descripción
operation string sí Debe ser query
sessionName string sí Identificador de sesión
query string sí Consulta SQL (codificada en URL)

Ejemplo de curl:

curl "https://apps.kafinea.com/YourKafinea/webservice.php?operation=query&sessionName=YOUR_SESSION_ID&query=SELECT%20*%20FROM%20Contacts%20WHERE%20lastname%3D'Dupont'%20LIMIT%2010%20;"

Formato de la consulta #

SELECT * | ColumnsList | count(*)
FROM ModuleName
WHERE Conditions
ORDER BY ColumnsList
LIMIT Offset, Limit ;

Importante: el punto y coma final es obligatorio.

Detalles:

Elemento Descripción
ColumnsList Lista de nombres de campos separados por comas
ModuleName Nombre del módulo de la entidad
Conditions Separadas por AND o OR, tratadas de izquierda a derecha. Sin agrupación con paréntesis.
Offset Entero (opcional)
Limit Entero

Tipos de condiciones disponibles:

Tipo Sintaxis Ejemplo
Operador <, >, <=, >=, !=, = lastname = 'Dupont'
IN IN(val1, val2, ...) industry IN('Tech', 'Finance')
LIKE LIKE 'pattern' lastname LIKE '%dup%'

Query Related — Consultar las listas relacionadas #

Esta operación permite obtener las entidades de las listas relacionadas de una entidad específica. La consulta sigue el mismo formato que query, pero sin punto y coma final.

GET https://apps.kafinea.com/{instance}/webservice.php

Parámetro Tipo Obligatorio Descripción
operation string sí Debe ser query_related
sessionName string sí Identificador de sesión
id string sí ID de Webservice de la entidad principal
relatedLabel string sí Nombre del módulo relacionado
query string sí Consulta SQL (codificada en URL, sin ; final)

Ejemplo de curl:

curl "https://apps.kafinea.com/YourKafinea/webservice.php?operation=query_related&sessionName=YOUR_SESSION_ID&id=21x3456&relatedLabel=Documents&query=SELECT%20*%20FROM%20Documents%20WHERE%20filesize%20%3E%2010000"

Ejemplo de consulta:

SELECT * FROM Documents WHERE filesize > 10000

Referencias asociadas 🔗 #