1) Server Ressourcen Information (Discovery)

Zugang über Webseite

Um eine Übersicht über die auf einem JAXForms Server vorhandenen Mandanten und deren Formulare, Datapools, Codelisten sowie globalen Komponenten zu erhalten. Bietet JAXForms eine integrierte Informationsseite an, welche auf jedem JAXForms Server (ab der Version 9.0.8) aufgerufen werden kann. Der Zugang erfolgt über Oauth2 Credentials: https://xyz.jaxforms.com/formservice/serverInfo/

Image AddedImage Added

Zweck

Diese Schnittstelle, welche mit der Version 9.0.8 eingeführt wurde, liefert eine zentrale Übersicht über die auf dem Server verfügbaren Ressourcen je Mandant. Neben allgemeinen Serverinformationen (Name, Version, Stage) enthält die Antwort strukturierte Listen zu Formularen, Global Components, Datapools und Code-Listen inklusive Links und CRC32-Hashes zur schnellen Änderungs- und Integritätsprüfung. 

...

Dieser Endpoint liefert den eigentlichen Datei-/Ressourceninhalt zu einer Ressource aus der Übersicht.
In der Praxis wird er nicht “frei” verwendet, sondern über die in /server/info/ressource gelieferten resourceLink-Felder (z.B. bei globalComponents[] und codeListResources[]).

Pfadparameter

• mandantId (string)
  Mandant, z.B. MY-MANDANT,SHOWCASE,SYSTEM

• type (string)
  Ressourcentyp (z.B. jfd für Global Components oder Formular-Definitionen, codes für Code-Listen)

• uuid (string)
  ID der konkreten Ressource innerhalb des Typs

Authentifizierung & Autorisierung

• Bearer Auth erforderlich (bearerAuth)

• Endpoint ist mit @RolesAllowed("Credential") abgesichert

• Zusaetzliche serverseitige Pruefung:

  • Wenn kein User im Security Context: 401 Unauthorized

  • Danach wird eine Admin-Autorisierung erzwungen (intern wird gegen ROLE_ADMIN geprüft)

Praktische Konsequenz: Download ist nur mit gültigem Token und ausreichenden Rechten möglich.

Response

• 200 OK
  Liefert den Ressourcenkontent als Stream.

  • Content-Type: application/octet-stream

  • Content-Disposition: attachment; filename="<dateiname>"

  • Der filename wird serverseitig aus der internen resourceId abgeleitet (alles nach dem letzten /).

• 404 Not Found
  Ressource existiert nicht (Kombination aus mandantId/type/uuid nicht gefunden).

• 401 Unauthorized
  Kein/ungültiger User (z.B. fehlender Token).

Resource Link zusammenbauen

resourceLink (bzw. activeResourceLink bei Formulardefinitionen) ist die vollständige Download-URL zu einer Ressource. Sie folgt immer dem gleichen Muster und wird aus festen und variablen Bestandteilen zusammengesetzt.

...

{baseUrl}/formservice/services/rest/resource/{mandantId}/{type}/{uuid}

Bestandteile

Versionen-Link 

Bei FormResources gibt es zusätzlich zu activeResourceLink auch baseResourceLink ist die Basis-URL, um den Download-Link für eine beliebige konkrete Formular-Version zusammenzubauen.

Die uuid für die verschiedenen Versionen sind unter formVersions[i].uuid und können wie folgt zusammengebaut werden:

...