Buscar K
Aparência
Aplicar template ao tenant
POST
/tenant/templates/apply
Aplica um template pré-configurado ao tenant, criando estruturas de dados, aplicações e dashboards.
O que são Templates?
Templates são configurações pré-definidas que incluem:
- Estruturas de tabelas do Data Warehouse
- Aplicações DataViz
- Dashboards e widgets pré-configurados
- Fluxos ETL (dataflows)
- Conexões de dados
Templates permitem provisionar rapidamente novos tenants com estruturas prontas para uso.
Comportamento
- Valida se o tenant existe e está ativo
- Valida se o template existe
- Aplica todas as estruturas do template ao tenant
- Recursos já existentes serão sobreescritos
Importante: Por padrão o apply é aditivo - adiciona recursos ao tenant sem remover os existentes. Com
espelhar=true, ele também poda o conteúdo de produto órfão (fora do template), deixando o tenant no estado canônico; usedryRun=truepara pré-visualizar a poda antes.
Recarga pós-apply (reloadPlan)
Quando o apply reconstrói ou cria tabelas, elas ficam vazias até a próxima carga. A resposta traz um reloadPlan (tabelas afetadas em ordem de dependência). Dispare as cargas imediatamente via POST /tenant/templates/reload passando esses itens.
Quando Usar
| Cenário | Uso Recomendado |
|---|---|
| Novo tenant | Use templateId na criação (POST /tenants) |
| Tenant existente | Use este endpoint |
| Atualização de template | Reaplicar para obter novas versões |
Obtendo Templates Disponíveis
Use o endpoint GET /tenants/templates para listar os templates disponíveis para seu cliente.
Mensagens de Erro
| Mensagem | Causa |
|---|---|
Tenant not found |
Tenant não existe ou foi excluído |
Template not found |
Template não existe ou não pertence ao cliente |
Autorizações
tenantBearerAuth
Token de acesso do tenant
TipoHTTP (bearer)
Corpo da Requisição
application/json
JSON
{
"templateId": 5
}
Respostas
Operação processada
application/json
JSON
{
"success": true,
"reloadPlan": [
{
"flowId": 39562,
"tableId": 56587,
"tableName": "RAW - Oportunidades",
"tokenId": 591,
"reason": "rebuilt",
"agentOnline": true
}
]
}