Skip to content

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

  1. Valida se o tenant existe e está ativo
  2. Valida se o template existe
  3. Aplica todas as estruturas do template ao tenant
  4. Recursos já existentes serão sobreescritos

Importante: A aplicação de template é uma operação aditiva - ela adiciona recursos ao tenant. Recursos existentes não são removidos.

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
}

Playground

Autorização
Corpo

Exemplos

Desenvolvido por VitePress OpenAPI