Versionshinweis
Verfügbar ab print-core 5.0 / brandbox 8
Wählen Sie bei einer Seite den Service "Print Generierung", um via Rest Ausgaben zu generieren.
POST
Ressource
/rest/v5/{identifier}
identifier: Identifikator der Page
Parameter
Parameter | Beispiel | Beschreibung | optional |
|---|---|---|---|
identifier | PrintDocument | Mit der Kombination aus identifier und id wird definiert, welcher Datensatz verarbeitet werden soll. Beispiele: PrintDocument → Generierung des gesamten Dokuments mit allen dessen PrintPages PrintPage → Generierung einer spezifischen PrintPage | Nein |
id | 1 | Mit der Kombination aus identifier und id wird definiert, welcher Datensatz verarbeitet werden soll. | Nein |
configuration | 2 | Die id des Datensatzes für die Generierung Konfiguration. Dort sollt auch die Ausgabeart definiert werden, die generiert werden soll. | Nein |
context | context[customkey]=customvalue&context[customkey2]=customvalue2 | Daten, die in den Generierung-Kontext geschrieben werden. | Ja |
Unterstützte Ausgabeformate
Es sind nicht automatisch alle Ausgaben unterstützt. Diese sind unterstützt:
Druck PDF (print-restful 1.0)
Response
Die Response ist abhängig der Ausgabe der Generierung Konfiguration.
Druck PDF - Beispiel
{
"body": {
"value": "123", // Id der generierten Datei
"type": "pdf",
"meta": {
"name": "mypdf.pdf",
"size": "12.34 MB",
"dpi": "300 dpi"
}
},
"code": 0,
"message": "",
"extra": []
}
Weitere Funktionen
GET PUT DELETE sind nicht implementiert.
Generierte Datei herunterladen
Nach der Generierung eines PDFs wird eine File-ID zurückgegeben. Damit kann mit dem Service Dateiaustausch die tatsächliche Datei heruntergeladen werden.