Representational State Transfer (abgekürzt REST) bezeichnet ein Programmierparadigma für verteilte Systeme, insbesondere für Webservices. REST ist eine Abstraktion der Struktur und des Verhaltens des World Wide Web. REST hat das Ziel, einen Architekturstil zu schaffen, der die Anforderungen des modernen Web besser darstellt.
Über REST können derzeit ein JSON oder XML der Formulardaten, Formularinstanz-PDFs sowie Beilagen (Attachments) für einzelne eingereichte Formulare konsumiert werden. Es wird neben der REST-URL ein gültiges Security-Token sowie eine Formular Instanzidentifikationsnummer (UUID) benötigt. Diese ID erhalten Sie über die SOAP Abfrage "getForms" oder aus dem JSON/XML.
Es existiert eine in Echtzeit generierte Swagger-Dokumentation der erhältlichen Endpunkte, welche sich standardmässig unter folgender URL finden lässt: /formservice/doc/rest-api/
Diese wird immer die auf dem System verfügbaren Möglichkeiten repräsentieren und unterscheidet sich dadurch gegebenenfalls von der Dokumentation des Wikis.
