Entidades

Los conjuntos de registros que leen los bloques del portal — cada entidad viene de una operación de una fuente de datos, de una consulta SQL, de una relación (join) entre otras dos o de registros que tú envías. records get consulta los registros sincronizados, records create y records import create alimentan una entidad sin conector, aggregate calcula lo que muestran KPIs y gráficos, y sync / tenant-syncs disparan y siguen la sincronización.

Comando	HTTP	Descripción
entities list	GET /v1/entities	Listar entidades
entities create	POST /v1/entities	Crear entidad
entities get	GET /v1/entities/{id}	Consultar entidad
entities update	PATCH /v1/entities/{id}	Actualizar entidad
entities delete	DELETE /v1/entities/{id}	Eliminar entidad
entities aggregate	GET /v1/entities/{id}/aggregate	Calcular agregados de los registros
entities usage	GET /v1/entities/{id}/usage	Uso de la entidad
entities join create	POST /v1/entities/join	Crear entidad de relación
entities join update	PUT /v1/entities/{id}/join	Modificar relación
entities join preview create	POST /v1/entities/join/preview	Vista previa de una relación
entities logs list	GET /v1/entities/{id}/logs	Registro de la sincronización
entities logs get	GET /v1/entities/{id}/logs/{log_id}	Consultar llamada de la sincronización
entities preview create	POST /v1/entities/preview	Vista previa de un origen
entities records list	GET /v1/entities/{id}/records	Consultar registros
entities records get	GET /v1/entities/{id}/records/{record_id}	Consultar registro
entities records create	POST /v1/entities/{id}/records	Enviar registros
entities records delete	DELETE /v1/entities/{id}/records	Limpiar registros
entities records import create	POST /v1/entities/{id}/records/import	Importar registros desde CSV
entities sync get	GET /v1/entities/{id}/sync	Estado de la sincronización
entities sync create	POST /v1/entities/{id}/sync	Sincronizar entidad
entities tenant-syncs list	GET /v1/entities/{id}/tenant_syncs	Sincronizaciones por titular
entities tenant-syncs create	POST /v1/entities/{id}/tenant_syncs	Sincronizar un titular

Ejemplos

--params lleva parámetros de query, de ruta y de encabezado (id, página, filtros, X-Workspace-Id); --json lleva el cuerpo de la solicitud; --fields limita los campos que vuelven — vale la pena en todo list/get, para ahorrar contexto. Mira Flags globales para la referencia completa.

# Listar entidades
kobana dashboards entities list --fields "id,key,name,sync_mode"

# Consultar registros
kobana dashboards entities records list \
  --params '{"id": "ENTITY_ID", "limit": 50, "sort": "due_date:desc"}'

# Calcular agregados de los registros
kobana dashboards entities aggregate \
  --params '{"id": "ENTITY_ID", "op": "sum", "field": "valor", "group_by": "status"}'

# Enviar registros
kobana dashboards entities records create \
  --params '{"id": "ENTITY_ID"}' \
  --json '{"records": [{"id": "42", "nome": "Ana Souza", "valor": 1250.5}], "mode": "upsert"}'

# Sincronizar entidad
kobana dashboards entities sync create --params '{"id": "ENTITY_ID"}'

# Estado de la sincronización
kobana dashboards entities sync get --params '{"id": "ENTITY_ID"}'

# Limpiar registros
kobana dashboards entities records delete \
  --params '{"id": "ENTITY_ID"}' \
  --dry-run

Próximos pasos

• Fuentes de datos
• Mapeo de usuarios del portal
• Introspección de schema — todos los parámetros que acepta este recurso.