Dokumentfunktionen - customX REST-Schnittstelle

Übersicht der Dokumentfunktionen

Dokument erzeugen

Diese Funktion dient als Auslöser, die automatisierte Produktion aller Dokumente des Projekts zu starten.

Example POST URL:
http://localhost/CustomXApp/Api/CreateAllDocuments

Example POST body:
{
"sessionid": "c009f9dc"
}

Example response:
true

Erforderliche Parameter

Antwort

Die Funktion liefert sofort ein true zurück und ist unabhängig vom Status der Erzeugung der Dokumente. Diese läuft im Hintergrund asynchron ab.

Statusabfrage der Dokumenterzeugung

Example POST URL:
http://localhost/CustomXApp/Api/GetDocumentCreationProgress

Example POST body:
{
"sessionid": "c009f9dc"
}

Example response:
{
"Total": 25,
"Produced": 11
}

Error response:
null

Erforderliche Parameter

Antwort

Zurückgegeben werden die zwei Parameter Total und Produced. Total gibt die Gesamtzahl an zu erzeugenden Dokumenten an und Produced, die Anzahl an Dokumenten, die bereits erzeugt wurden. Die Funktion sollte regelmäßig aufgerufen werden, bis Total und Produced übereinstimmen.

Einzelnes Dokument erzeugen und als Stream erhalten

Example POST URL:
http://localhost/CustomXApp/Api/GetDocument

Example POST body:
{
"sessionid": "c009f9dc",
"documentName": "Angebot"
}

Example response:
bytearray

Error response:
null

Erforderliche Parameter

Antwort

Die Antwort ist ein bytearray (byte[]) oder null im Falle eines Fehlschlags.