Versionen im Vergleich

Alte Version 37

changes.mady.by.user Oliver Brausch

Gespeichert am

verglichen mit

Neue Version Aktuell

changes.mady.by.user Inga Sertel

Gespeichert am

Schlüssel

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

Anzeige untergeordneter Seiten


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.

Er ist unter dem Pfad

...

Codeblock
/rest

...

zu erreichen, z.B. für eine lokale Installation des Servers auf dem Port 8080
...
:
...
Session:
...
...
http://localhost:8080/nuclos-war/rest/
...
Teilservices/Pfade:
  • Login (Path: /login, Method: POST, Return: String)
    Erwartet die Login-Daten per JSON (s. JSON-Spezifikationen), 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.
...
.
...
.
...
JSON-Spezifikationen:
  • Login ("username": String, "password": String, "locale": String (optional))
    Beispiel für ein gültiges Login-JSON-Objekt:
     Codeblock
    var login = {
	"username": "user123", 
	"password": "passXYZ", 
	"locale": "de_DE"};
...
Filter ("search": String, "offset": Number, "chunksize": Number, "sort": String, alle optional)
Beispiel für ein gültiges Filter-JSON-Objekt:
 Codeblock
var filter = {
	"search": "Hu", 
	"offset": 0, 
	"chunksize": 100, 
	"sort": "szU1s75TFT6kGF7l0Whj=asc"};
ValueObject ("uid": String, "pk": String, "<FieldUID>": Object, beliebige Anzahl)
Beispiel für ein gültiges ValueObject-JSON-Objekt:
 Codeblock
var vo = {
	"uid":"KIb7Pmxm3AnJtdBWXWsJ",
 	"pk":"40000191",
 	"nyVRqlqCUYvH3GNwlKrn":400,
 	"zTc3H0vtH5o2JV82gRtg":"Schraube"}
 
...
 Codeblock
{"uid":"KIb7Pmxm3AnJtdBWXWsJ",
 "statemodel":false,
 "name":"Artikel"}
...
SearchResult ("uid": String, "name": String, "pk": String, "text": String)
Beispiel für ein SearchResult-JSON-Objekt:
 Codeblock
{"uid":"KIb7Pmxm3AnJtdBWXWsJ",
 "name":"Artikel"
 "pk":"40000217"
 "text":"anzahl=4, lieferung=2013-06-28, lieferbar=null, name=Schrank, preis=256.17"}
...
.
...
 Codeblock
{"total":4,"vos":[
{"uid":"KIb7Pmxm3AnJtdBWXWsJ","nyVRqlqCUYvH3GNwlKrn":400,"zTc3H0vtH5o2JV82gRtg":"Schraube","pk":"40000191"},  {"uid":"KIb7Pmxm3AnJtdBWXWsJ","nyVRqlqCUYvH3GNwlKrn":41,"zTc3H0vtH5o2JV82gRtg":"Stuhl","pk":"40000192"}]}