Über die REST-API können Sie automatisiert auf verschiedene Funktionen des Systems zugreifen, zum Beispiel auf Dokumente oder Formulare. Für die Nutzung stellt das System eine integrierte API-Dokumentation bereit.
Aufruf der API-Dokumentation
Die Dokumentation ist direkt über Ihren formcycle-Server erreichbar. Sie benötigen lediglich die Basis-URL Ihres Systems und ergänzen diese um die entsprechenden Pfade.
HTML-Dokumentation
Die HTML-Version ist für die Nutzung im Browser gedacht und bietet eine übersichtliche Darstellung aller verfügbaren Endpunkte.
Folgende Bereiche stehen zur Verfügung:
/api/rest/public/security/doc/openapi.html/api/rest/public/doc/openapi.html/api/rest/public/forms/doc/openapi.html/api/rest/public/form-records/doc/openapi.html/api/rest/public/users/doc/openapi.html/api/rest/public/user-portals/doc/openapi.html
Beispiel:
https://ihr-server.de/api/rest/public/users/doc/openapi.html
Wird formcycle in einem Unterpfad betrieben (z.B.https://ihr-server.de/formcycle, muss dieser Bestandteil der URL sein. Beispiel:https://ihr-server.de/formcycle/api/rest/public/users/doc/openapi.html
JSON-Format
Die JSON-Version eignet sich für die Weiterverarbeitung in Tools oder zur automatischen Integration.
/api/rest/public/security/doc/openapi.json/api/rest/public/doc/openapi.json/api/rest/public/forms/doc/openapi.json/api/rest/public/form-records/doc/openapi.json/api/rest/public/users/doc/openapi.json/api/rest/public/user-portals/doc/openapi.json
YAML-Format
Alternativ steht die Dokumentation auch im YAML-Format zur Verfügung.
/api/rest/public/security/doc/openapi.yaml/api/rest/public/doc/openapi.yaml/api/rest/public/forms/doc/openapi.yaml/api/rest/public/form-records/doc/openapi.yaml/api/rest/public/users/doc/openapi.yaml/api/rest/public/user-portals/doc/openapi.yaml
Hinweise
- Die API-Dokumentation basiert auf dem OpenAPI-Standard.
- Je nach Systemkonfiguration kann ein Zugriff nur mit entsprechender Berechtigung möglich sein.
War dieser Artikel hilfreich?
Das ist großartig!
Vielen Dank für das Feedback
Leider konnten wir nicht helfen
Vielen Dank für das Feedback
Feedback gesendet
Wir wissen Ihre Bemühungen zu schätzen und werden versuchen, den Artikel zu korrigieren
