Seitenhistorie
| 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/...
....
....
Session:
...
Zu Debug-Zwecken ist vorläufig auch die Möglichkeit gegeben, die Session ID als Query-Parameter zu übergeben. Als Beispiel würde dies hier bei gültiger Session ID funktionieren: http://localhost:8080/nuclos-war/rest/meta/entities?sessionid=i8F3KD12V9c13SqDsvcT
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 ValueObject-JSON-Objekt:Codeblock {"uid":"KIb7Pmxm3AnJtdBWXWsJ", "pk":"40000191", "nyVRqlqCUYvH3GNwlKrn":400, "zTc3H0vtH5o2JV82gRtg":"Schraube"}
Result ("total": Number, "vos": JSONArray kit ValueObject)
Beispiel für ein Result-JSON-Objekt:Codeblock {"total":4,"vos":[ {"uid":"KIb7Pmxm3AnJtdBWXWsJ","nyVRqlqCUYvH3GNwlKrn":400,"zTc3H0vtH5o2JV82gRtg":"Schraube","pk":"40000191"}, {"uid":"KIb7Pmxm3AnJtdBWXWsJ","nyVRqlqCUYvH3GNwlKrn":41,"zTc3H0vtH5o2JV82gRtg":"Stuhl","pk":"40000192"}]}
...
....
Überblick
Inhalte