REST Explorer

Der REST Explorer wird mit Nuclos mit installiert, ist also Teil von Nuclos selbst, und liefert einen groben Überblick über die von Nuclos zur Verfügung gestellten Schnittstellen. Er ist daher ein idealer Einstieg in dieses Thema.

Alle auf diesen Seiten gezeigten beispielhaften Inhalte beziehen sich auf das Nuclet 2. Rest example.

Voraussetzungen

Start des REST Explorer

Nach erfolgreichem Login im Webclient finden Sie im Menü Dev den REST Explorer vor.

Verwenden des REST Explorers

Auf der linken befindet sich das Menü. Hier im Screenshot beispielhaft für die Version 4.4.3.

Nach Auswahl einer Methode werden im rechten Bereich die Details angezeigt. Diese unterteilen sich in

1. URL
   häufig sind die Teile der URL parametrisiert, erkennbar an den geschweiften Klammern z.B. "{boMetaId}" und können bearbeitet werden.
2. Request Parameter
   Im Regelfall ein JSON Objekt 
3. Response
   Im Regelfall ein JSON Objekt  

Die Methode /bos zeigt alle BOs, für die direkt eine Ergebnisliste abgerufen werden kann:

 bos

Durch klick auf z.B. den zweiten Link (http://localhost:8080/nuclos-war/rest/bos/example_rest_Order) gelangt man zur Ergebnisliste des BOs "example_rest_Order":

 bos/example_rest_Order

Der erste Link (http://localhost:8080/nuclos-war/rest/bos/example_rest_Order/40000308) dieser Liste zeigt nun einen vollständigen Detail Datensatz zur ausgewählten Order:

 bos/example_rest_Order/40000308