Catalisa.Building Blocks
Catálogo/Document Template/API

API do Document Template

11 endpoints em 3 recursos. A permissão de cada rota é a que o código exige — conferida linha a linha, não copiada do nome.

Ver a referência detalhada, com corpo de requisição e catálogo de erros →

12 endpoints

Templates

/document-templates/api/v1/document-templates8
  • POST/document-templates/api/v1/document-templatesCria template em DRAFT. Responde 201DOCUMENT_TEMPLATES_CREATE
  • GET/document-templates/api/v1/document-templatesLista templates, paginadoDOCUMENT_TEMPLATES_READ
  • GET/document-templates/api/v1/document-templates/:templateIdBusca o template (mostra o **rascunho**)DOCUMENT_TEMPLATES_READ
  • PATCH/document-templates/api/v1/document-templates/:templateIdAtualiza o rascunhoDOCUMENT_TEMPLATES_UPDATE
  • DELETE/document-templates/api/v1/document-templates/:templateIdExclusão lógica. Responde 204DOCUMENT_TEMPLATES_DELETE
  • POST/document-templates/api/v1/document-templates/:templateId/publishCongela o rascunho em uma versão novaDOCUMENT_TEMPLATES_PUBLISH
  • GET/document-templates/api/v1/document-templates/:templateId/versionsLista versões, paginadoDOCUMENT_TEMPLATES_READ
  • GET/document-templates/api/v1/document-templates/:templateId/versions/:versionNumberBusca uma versão específicaDOCUMENT_TEMPLATES_READ

Renderização

/document-templates/api/v1/document-templates3
  • POST/document-templates/api/v1/document-templates/:templateId/renderRenderiza em HTML e registra a emissãoDOCUMENT_TEMPLATES_RENDER
  • POST/document-templates/api/v1/document-templates/:templateId/render/pdfRenderiza em PDF (base64) e registra a emissãoDOCUMENT_TEMPLATES_RENDER
  • POST/document-templates/api/v1/document-templates/:templateId/previewPré-visualiza o **rascunho**, sem validar e sem gravarDOCUMENT_TEMPLATES_RENDER

Saúde

/document-templates/health1
  • GET/document-templates/healthSonda de disponibilidade. Pública, não contabilizada nas 11 rotas