Webflow API ist eine standardisierte, REST-Basierte Schnittstelle für die Kommunikation mit dem FIVE Webflow System.
Authentifizierung
Bei jeder Anfrage muss der Parameter „apiKey“ mit einem entsprechenden apiKey gesendet werden. API Keys können im Admin Bereich von FIVE Webflow generiert werden (dafür werden Admin Rechte benötigt) http://[host]/api/ApiConfig/index.html
Wir empfehlen für jedes System das auf die API zugreift einen separaten apiKey zu generieren um einzelne Dienste in den Logs identifizieren zu können oder aber die Dienste einzeln ausschliessen zu können.
Encoding
Webflow API unterstützt UTF-8 encoding
Spezielle Datentypen
Das Format des Datentyps „Date“ hängt von der jeweiligen Sprache des API Users ab
Antwortformate können über den URL Parameter ‚format=‘ gesteuert werden. Die Antwort erfolgt im entsprechenden Format. Die Standard Antwort erfolgt als json.
Webflow unterstützt die folgenden Antwortformate:
| Format |
Bemerkung |
| json |
Standard bei Abfrage via API |
| html |
Standard bei Abfrage via Browser |
| xml |
Experimentell |
Antworttypen
Webflow liefert HTTP Status Antworten. Je nach Status kann darauf geschlossen werden ob ein Fehler vorliegt oder die Abfrage erfolgreich war.
Webflow unterstützt die folgenden Antworttypen:
| HTTP Status |
Bezeichnung |
Antwort |
| 200 |
Erfolgreich |
Angefragte Daten (Anfragespezifisch) |
| 400 |
Parameter fehlerhaft |
Fehlermeldung |
| 401 |
Authentifizierung fehlerhaft |
Fehlermeldung |
| 423 |
Modul deaktiviert |
Fehlermeldung |
| 500 |
Server Fehler |
Fehlermeldung, Details sind im Webflow Log ersichtlich |
Aufgabenliste
Die Abfrage liefert eine Objekt-Liste mit allen Aufgaben zurück
Geschäftsfall erstellen
Anfrage
Parameterliste
| Bezeichnung |
Name |
Datentyp |
Erforderlich |
| Mandant ID |
gf_MANDANTID |
String (5) |
Ja |
| Klasse ID |
gf_KLASSEID |
Int |
Ja |
| Referenz ID |
gf_REFERENZID |
String (50) |
Ja |
| Belegart |
gf_BELEGART |
Int |
Ja |
| BPMN Revision ID |
gf_BPMN_REVISION_ID |
Int |
Wenn Belegart == 6 |
| Titel ID |
gf_TITELID |
String |
Wenn Belegart != 6 |
| Bemerkung |
gf_BEMERKUNG |
String (255) |
|
| Sicherheitsbereich |
gf_SECCODID |
Int |
|
| Erledigt bis |
gf_ERLRDIGTBIS |
Date |
Ja |
| Benutzer ID |
gf_USERID |
Int |
Benutzer oder Gruppe |
| Gruppe ID |
gf_ROLEID |
Int |
Benutzer oder Gruppe |
| Notiz |
NOTIZ |
String (2000) |
|
| Wiedervorlage Datum |
ERSCHEINUNGSDATUM |
Date |
|
Spezielle Antworten
| HTTP Status |
Bezeichnung |
Inhalt |
| 200 |
Erfolgreich |
Geschäftsfall ID (int) |
Dokument uploaden
Anfrage
Parameter
| Bezeichnung |
Name |
Datentyp |
Erforderlich |
| Datei |
file |
int |
|
| Geschäftsfall ID |
gf_id |
int |
Wenn mandant_id leer ist |
| Mandant ID |
mandant_id |
String (5) |
Wenn gf_id leer ist |
| Barcode |
barcode |
Varchar(128) |
|
| Notiz |
fileDescription |
Varchar(255) |
|
| Scan Datum |
scanDate |
Date |
|
Spezielle Antworten
| HTTP Status |
Bezeichnung |
Inhalt |
| 200 |
Erfolgreich |
Leer |
| 403 |
Auf diesen Geschäftsfall darf nicht zugegriffen werden |
Fehlermeldung |
| 404 |
Geschäftsfall nicht gefunden |
|
Aufgabe abschliessen
Beim Abschluss einer Aufgabe in einem BPMN Geschäftsfall wird anschliessend der Prozess weitergeführt und weitere Aufgaben erstellt oder der Geschäftsfall abgeschlossen.
Beim Abschluss der letzten Inbox Aufgabe wird anschliessend der Geschäftsfall abgeschlossen.
Anfrage
Spezielle Antworten
| HTTP Status |
Bezeichnung |
Inhalt |
| 200 |
Erfolgreich |
Leer |
| 403 |
Auf diese Aufgabe darf nicht zugegriffen werden |
Fehlermeldung |
| 404 |
Aufgabe nicht gefunden |
|
