Seitenhistorie
| Anzeige untergeordneter Seiten |
|---|
Er
| Warnung |
|---|
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
...
:
Jeder Teilservice außer dem Login benötigt eine Session ID. Wird keine Session ID übergeben, bzw. ist die Session ID ungültig, gibt der Service einen Fehler mit dem HTTP Status 401 (Unauthorized) zurück. Die Session ID kann entweder als Standard-Cookie oder als Http-Header-Parameter beim Aufruf des REST-Services übergeben werden. Der Key muss "sessionid" lauten.
...
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-JSONObject: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-JSONObject:
| 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-JSONObject:
| Codeblock |
|---|
var vo = {
"uid":"KIb7Pmxm3AnJtdBWXWsJ",
"pk":"40000191",
"nyVRqlqCUYvH3GNwlKrn":400,
"zTc3H0vtH5o2JV82gRtg":"Schraube"} |
...
Entity ("uid": String, "statemodel": Boolean, "name": String)
Beispiel für ein Entity-JSONObject:
| Codeblock |
|---|
{"uid":"KIb7Pmxm3AnJtdBWXWsJ",
"statemodel":false,
"name":"Artikel"} |
...
Field ("uid": String, "name": String, "type": String, "readonly": Boolean, "unique": Boolean, "nullable": Boolean, order: Array[Integer])
Beispiel für ein Field-JSONObject:
| Codeblock |
|---|
{"uid":"KIb7Pmxm3AnJtdBWXWsJ",
"name":"Bestand",
"type":"Integer",
"readonly":false,
"unique":false,
"nullable":true,
"order",[3]} |
Result ("total": Number, "vos": JSONArray von ValueObjects)
"total" ist die Anzahl alle Datensätze, die die Suche ohne Einschränkung der Blockgröße gefunden hat. Beispiel für ein Result-JSONObject:Codeblock {"total":4,"vos":[ {"uid":"KIb7Pmxm3AnJtdBWXWsJ","nyVRqlqCUYvH3GNwlKrn":400,"zTc3H0vtH5o2JV82gRtg":"Schraube","pk":"40000191"}, {"uid":"KIb7Pmxm3AnJtdBWXWsJ","nyVRqlqCUYvH3GNwlKrn":41,"zTc3H0vtH5o2JV82gRtg":"Stuhl","pk":"40000192"}]}SearchResult ("uid": String, "name": String, "pk": String, "text": String)
Beispiel für ein SearchResult-JSONObject:Codeblock {"uid":"KIb7Pmxm3AnJtdBWXWsJ", "name":"Artikel" "pk":"40000217" "text":"anzahl=4, lieferung=2013-06-28, lieferbar=null, name=Schrank, preis=256.17"}
HTTP-Statuscodes:
...
....
....
....
Überblick
Inhalte