API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · dms_templates

DMS Template Schema

Schema-ID
dms_template
Collection
dms_templates
Permissions
  • Lesendms_template_view
  • Anlegendms_template_create
  • Änderndms_template_edit
  • Löschendms_template_delete

Felder

DMS Template Schema

dms_templates4 Permissions

Schema for validating DMS PDF generation templates (PDF-Vorlagen)

namestringerforderlich

Template name

1–200 Zeichen
descriptionstringoptional
nullable
templateTypestringerforderlich

Type of document this template generates

Werte
INVOICEOFFERCONTRACTREPORTLETTERCUSTOM
enginestringerforderlich

Rendering engine (Puppeteer + Handlebars)

Werte
HTML_PDF
Default: "HTML_PDF"
htmlTemplatestringoptional

Handlebars HTML template body

nullable
cssStylesstringoptional

CSS styles for the template

nullable
headerHtmlstringoptional

HTML for page header

nullable
footerHtmlstringoptional

HTML for page footer

nullable
variablesobject[]optional

Template variables with types

Default: []
namestringerforderlich
typestringerforderlich
Werte
stringnumberdatebooleanarrayobject
requiredbooleanoptional
Default: false
defaultValueanyoptional
descriptionstringoptional
nullable
orientationstringoptional
Werte
PORTRAITLANDSCAPE
Default: "PORTRAIT"
paperSizestringoptional
Werte
A4A3LETTERLEGAL
Default: "A4"
marginsobjectoptional
nullable
topstringoptional
nullable
rightstringoptional
nullable
bottomstringoptional
nullable
leftstringoptional
nullable
sampleDataobjectoptional

Sample JSON data for template preview

nullable
thumbnailS3Keystringoptional

S3 key for template preview thumbnail

nullable
isActivebooleanoptional
Default: true
sortOrdernumberoptional
Default: 0

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/dms_templates — Liste, paginiert + filterbar
  • GET /api/v1/dms_templates/<id> — Einzelne Entity
  • POST /api/v1/dms_templates — Anlegen
  • PATCH /api/v1/dms_templates/<id> — Teil-Update
  • DELETE /api/v1/dms_templates/<id> — Soft-Delete
  • GET /api/v1/dms_templates/<id>/timeline — Audit + Aktivitäten

Suche