Skip to content

Aplicar um template​

POST
/tenant/templates/apply

Aplica um template do Cliente no Tenant do token. É o caminho para instalar um template num Tenant que já existe, ou reaplicar uma versão nova; na criação, mande templateId em POST /tenants. Os templates do Cliente estão em GET /tenants/templates.

O template traz tabelas do HorusDW, Dataflows, agendamentos, Aplicações com Dashboards, os nomes das variáveis globais (o valor fica no Tenant) e as conexões, que nascem vazias e se preenchem em PUT /tenant/credentials/{id}.

Por padrão o apply só acrescenta: nada que já existe no Tenant é removido. Com espelhar=true, ele também poda o conteúdo de produto que não está no template; use dryRun=true para ver a poda antes.

Prévia (preview)

Com preview: true, nada é gravado. A resposta diz, por mesa, conexão, variável, tabela, Dataflow, agendamento e aplicação, se o apply vai criar (create), reescrever (update) ou manter (keep), e lista em rebuilds as tabelas que serão recriadas e ficarão vazias até a próxima carga. Com espelhar: true junto, traz também o plano do espelho em plan.

dryRun continua como sempre: com espelhar, devolve o plano do espelho; sem espelhar, instala o template de verdade. Para ver antes sem instalar, use preview.

Recarga depois do apply (reloadPlan)

Tabela criada ou reconstruída pelo apply fica vazia até a próxima carga. A resposta traz em reloadPlan essas tabelas, em ordem de dependência; para carregar na hora, mande os itens em POST /tenant/templates/reload.

A resposta também traz credenciaisVazias, variaveisVazias e tabelasVazias: o que o template criou sem valor ou sem carga.

Mensagens de erro

Mensagem Causa
Tenant not found Tenant não existe ou foi excluído
Template not found Não existe template ativo com esse templateId, ou ele é de outro cliente

Autorizações​

tenantBearerAuth

Token de acesso do tenant

TipoHTTP (bearer)

Corpo da Requisição​

application/json
JSON

Respostas​

Operação processada

application/json
JSON

Playground​

Autorização
Corpo

Exemplos​

Desenvolvido por VitePress OpenAPI