Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

Anzeige untergeordneter Seiten


Er

Hinweis: Der Service befindet sich im Entwicklungsstadium. D.h. es wird sich noch einiges ändern, insbesondere die Struktur der Daten.

Einführung:

Ab Nuclos 4.0 hat der Nuclos Server einen RESTful Service integriert, der automatisch gestartet wird. Er dient primär als Interface für einen Webclient, kann aber auch grundsätzlich als Dienst verwendet werden.

...

ist unter dem Pfad

...

Codeblock
/rest

...

zu erreichen, z.B. für eine lokale Installation des Servers auf dem Port

...

8080

...

:

...

...

http://localhost:8080/nuclos-war/rest

...

Teilservices/Pfade:

...

Login (Path: /login, Method: POST, Return: String)
Erwartet ein JSON-Objekt mit den Logindaten ("locale" ist optional), authentifiziert sich damit am Nuclos-Server und gibt eine SessionID als String zurück. Die Session ID benötig wird um alle anderen Teilservices zu verwenden. Schlägt der Login fehl, wird ein Fehler mit dem HTTP Status 401 (Unauthorized) zurückgeworfen. Beispiel für ein gültiges JSON-Objekt unter JavaScript:

Codeblock
var login = {"username": "user123", "password": "passXYZ", "locale": "de_DE"};

...

/

...

.

...

.

...

JSON-Spezifikationen

  • Filter ("search": String, "offset": Number, "chunksize": Number, "sort": String)
    Beispiel für ein gültiges Filter-JSON-Objekt:

    Codeblock
    var filter = {
    	"search": "Hu", 
    	"offset": 0, 
    	"chunksize": 100, 
    	"sort": "szU1s75TFT6kGF7l0Whj=asc"};

 

...

.

...