Entidades

Os conjuntos de registros que os blocos do portal leem — cada entidade vem de uma operação de uma fonte de dados, de uma consulta SQL, de uma relação (join) entre duas outras ou de registros enviados por você. records get consulta os registros sincronizados, records create e records import create alimentam uma entidade sem conector, aggregate calcula o que KPIs e gráficos mostram, e sync / tenant-syncs disparam e acompanham a sincronização.

Comando	HTTP	Descrição
entities list	GET /v1/entities	Listar entidades
entities create	POST /v1/entities	Criar entidade
entities get	GET /v1/entities/{id}	Consultar entidade
entities update	PATCH /v1/entities/{id}	Atualizar entidade
entities delete	DELETE /v1/entities/{id}	Remover entidade
entities aggregate	GET /v1/entities/{id}/aggregate	Calcular agregados dos registros
entities usage	GET /v1/entities/{id}/usage	Uso da entidade
entities join create	POST /v1/entities/join	Criar entidade de relação
entities join update	PUT /v1/entities/{id}/join	Alterar relação
entities join preview create	POST /v1/entities/join/preview	Prévia de uma relação
entities logs list	GET /v1/entities/{id}/logs	Log da sincronização
entities logs get	GET /v1/entities/{id}/logs/{log_id}	Consultar chamada da sincronização
entities preview create	POST /v1/entities/preview	Prévia de uma origem
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	Limpar registros
entities records import create	POST /v1/entities/{id}/records/import	Importar registros por CSV
entities sync get	GET /v1/entities/{id}/sync	Estado da sincronização
entities sync create	POST /v1/entities/{id}/sync	Sincronizar entidade
entities tenant-syncs list	GET /v1/entities/{id}/tenant_syncs	Sincronizações por titular
entities tenant-syncs create	POST /v1/entities/{id}/tenant_syncs	Sincronizar um titular

Exemplos

--params carrega parâmetros de query, de caminho e de cabeçalho (id, página, filtros, X-Workspace-Id); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência 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 dos 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 entidade
kobana dashboards entities sync create --params '{"id": "ENTITY_ID"}'

# Estado da sincronização
kobana dashboards entities sync get --params '{"id": "ENTITY_ID"}'

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

Próximos passos

• Fontes de dados
• Mapeamento de usuários do portal
• Introspecção de schema — todos os parâmetros que este recurso aceita.