Endpoints
Templates (Dokumentvorlagen) – Verwaltung von Dokumentvorlagen
| Methode | Pfad | Parameter | Beschreibung |
|---|---|---|---|
| GET | /api/Templates | - Limit: int32 (benötigt) - Offset: int32 (benötigt) - tenant: string (optional) |
Abrufen aller Dokumentvorlagen mit einem gegebenen Limit (Begrenzung) und Offset (Startpunkt) |
| GET | /api/Templates/{templateId} | - templateId: string (benötigt) - tenant: string (optional) |
Abrufen einer Dokumentenvorlage anhand einer TemplateId |
| POST | /api/Templates/{templateId} | - templateId: string (benötigt) - description: string (benötigt) - fileListLabel: .lst-Datei (benötigt) - fileJsonSchema: .json-Datei (benötigt) - tenant: string (optional) |
Erstellen einer Dokumentenvorlage mit den übergebenen Daten |
| PUT | /api/Templates/{templateId} | - templateId: string (benötigt) - description: string (benötigt) - fileListLabel: .lst-Datei (benötigt) - fileJsonSchema: .json-Datei (benötigt) - tenant: string (optional) |
Aktualisieren einer Dokumentenvorlage anhand einer TemplateId |
| DELETE | /api/Templates/{templateId} | - templateId: string (benötigt) - tenant: string (optional) |
Löschen (Setzen von DeletedOn & -By) einer Dokumentenvorlage anhand einer TemplateId |
Documents (Dokumente) – Steuerung der Dokumentengenerierung
| Methode | Pfad | Parameter | Beschreibung |
|---|---|---|---|
| POST | /api/Documents/{templateId} | - templateId: string (benötigt) - tenant: string (optional) |
Generierung eines PDF-Dokuments anhand einer Dokumentenvorlage und JSON-Daten. Die JSON-Daten müssen dem Schema der Dokumentenvorlage entsprechen. Rückgabe als PDF-Datei. |
| GET | /api/Documents/{templateId}/sample | - templateId: string (benötigt) - tenant: string (optional) |
Ermitteln von Beispieldaten für die PDF-Dokumentengenerierung anhand der Dokumentvorlage mit der TemplateId. |