Sie zeigen eine alte Version dieser Seite an. Zeigen Sie die aktuelle Version an.

Unterschiede anzeigen Seitenhistorie anzeigen

« Vorherige Version anzeigen Version 82 Nächste Version anzeigen »

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 "/rest/*" zu erreichen, z.B. für eine lokale Installation des Servers auf dem Port 8080:

http://localhost:8080/nuclos-war/rest/<pfad>.  (z.B. für logout: http://localhost:8080/nuclos-war/rest/logout)

Session:

Jeder Teilservice bis auf weniger Ausnahmen (z.B. 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.

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:

  • Version (Path: /version, Method: GET, Return: String, ohne Session)
    Version des Nuclos-Servers.

  • Login (Path: /login, Method: POST, Return: String, ohne Session)
    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 andere Teilservices zu verwenden. Schlägt der Login fehl, wird ein Fehler mit dem HTTP Status 401 (Unauthorized) zurückgeworfen.

  • Logout (Path: /logout, Method: GET)
    Invalidiert die bestehende Session ID. Diese Methode gibt den HTTP Status 200 (OK), wenn die Session ID gültig war.

  • EntityMeta (Path: /meta/entity/{uid}, Method: GET, Return: JSONObject "EntityMeta")
    Liefert die Metadaten der Entität {uid} mit ihren Feldern zurück

  • PreviewData (Path: /data/preview/{uid}, Methods: GET/POST, Return: JSONObject "PreviewResult")
    Mit GET werden die Vorschaudaten der ersten 1000 Datensätze der Entität {uid} geladen. Mit POST kann ein Filter (s. JSON-Spezifikationen) übergeben werden.

  • LoadData (Path: /data/load/{uid}, Methods: GET/POST, Return: JSONObject "Result")
    Mit GET werden die ersten 1000 Datensätze der Entität {uid} geladen. Mit POST kann ein Filter (s. JSON-Spezifikationen) übergeben werden.

  • GetData (Path:/data/get/{uid}/{pk}, Method: GET, Return: Return: JSONObject "Result")
    Es wird der Datensatz der Entität {uid} mit dem Primärschlüssel {pk} zurückgegeben, falls er existiert.

  • Search (Path: /data/search/{text}, Method: GET, Return: JSON-Array "SearchResult")
    Durchsucht die Entitäten nach dem Suchtext {text} mit Hilfe des Lucene-Indexes.

  • Count (Path: /data/count/{uid}, Method: GET/POST, Return: Number)
    Zählt die Anzahl der Datensätze der Entität {uid}. Mit POST kann ein Filter (s. JSON-Spezifikationen) übergeben werden.

  • InsertUpdate (Path: /data/insertupdate, Method: POST, Return: JSONObject "ValueObject")
    Erwartet ein JSONObject "ValueObject" von einem neuem oder alten Datensatz. Dieser wird mit je nach flag mit INSERT in die Datenbank geschrieben oder mit UPDATE verändert. Falls kein Fehler auftritt, wird der Datensatz direkt aus der Datenbank nach der Operation zurückgegeben.
    Mit dem Feld "_newstate" kann ein Statuswechsel ausgeführt werden.

  • Delete (Path: /data/delete/{uid}/{pk}, Method: DELETE)
    Löscht einen Datensatz mit dem Primary Key {pk} aus der Entität {uid}. Sobald der Datensatz ordnungsgemäß entfernt wurde, wird ein HTTP Status 200 (OK) zurückgegeben.

  • ReferenceList (Path: /data/referencelist/{field}, Method: GET, Return: JSON-Array "ReferenceValue")
    Erstellt eine Liste von Reference-Werten zum Feld {field}. Momentan auf Maximal 1000 Einträge beschränkt.

  • SubEntities (Path: /meta/subentities/{uid}, Method: GET, Return: JSON-Array "SubEntity")
    Alle abhängigen Sub-Entitäten (Unterformulare) zur Entität {uid} werden mit dem jeweiligen Referenzfeld erzeugt.

  • SubLoad (Path: /data/subload/{field}/{fk}, Method: GET, Return: JSONObject "Result")
    Lädt die Unterformulardatan einer Sub-Entität mit dem Fremdschlüssel {fk} im Feld {field}. Die Sub-Entität ist durch das referierende Feld {field} gegeben.

  • Menu (Path: /meta/menu, Method: GET, Return: JSONArray "Menu")
    Das Menü in der Sprache des angemeldet Benutzers. Hinweis: Momentan werden nur Menüeinträge für Entitäten bis zum Level 1 bereitgestellt.

  • Tasks (Path: /meta/tasks, Method: GET, Return: JSONArray "Menu")
    Das Menü bestehend aus Tasks (Entitäten mit Suchfilter) in der Sprache des angemeldet Benutzers. Hinweis: Momentan werden nur Menüeinträge für Entitäten bis zum Level 1 bereitgestellt.

  • EntityIcon (Path: /meta/entityicon/{uid}.png, Method: GET, Return: "image/png", ohne Session)
    Das Icon einer Entität als PNG-Image. Die Datei-Endung ".png" kann auch optional weggelassen werden.

JSON-Spezifikationen:

  • Login ("username": String, "password": String, "locale": String (optional))
    Beispiel für ein gültiges Login-JSONObject:

    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:

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

    -

  • ValueObject ("uid": String, "pk": Number/String, "_flag": "insert/update/delete", "<FieldUID>": Object, beliebige Anzahl, "_states": Array aus States, optional)
    Beispiel für ein gültiges ValueObject-JSONObject:

    var vo = {
	"uid":"KIb7Pmxm3AnJtdBWXWsJ",
 	"pk":40000191,
 	"nyVRqlqCUYvH3GNwlKrn":400,
 	"zTc3H0vtH5o2JV82gRtg":"Schraube",
	"_flag":"update",
    "_newstate": 40000344}

    -

  • ValueObjectWithSubData ("uid": String, "pk": Number/String, "<FieldUID>": Object, beliebige Anzahl, "_subvos": Array aus ValueObjects)

    Beispiel für ein gültiges ValueObjectWithSubData-JSONObject:

    var vo = {
	"uid":"A375TFTm3AnJtdBWJtdB",
 	"pk":40002037,
 	"szU1s75TFT6kGF7l0Whj":400,
	"_flag":"insert",
    "_subvos":[{"uid":"KIb7Pmxm3AnJtdBWXWsJ","zTc3H0vtH5o2JV82gRtg":"Schraube","pk":40000191,"flag":"update"},
              {"uid":"KIb7Pmxm3AnJtdBWXWsJ","zTc3H0vtH5o2JV82gRtg":"Stuhl","pk":40000192,"flag":"delete"}]}

     

     

  • EntityMeta ("uid": String, "statemodel": Boolean, "name": String, "statemodel": Boolean, "fields": Array aus Fields)
    Beispiel für ein Entity-JSONObject:

    {"uid":"KIb7Pmxm3AnJtdBWXWsJ",
 "name":"Artikel",
 "statemodel":false,
 "fields:[{"uid":"cjJ9ga7T6rEnl9FNMNrMdy2","name":"Name","type":"String",
           "readonly":false,"unique":true,"nullable":false,"reference":false,"order":0},
          {"uid":"wwS2lLCi6Rs57E","name":"Bestand","type":"Number",
           "readonly":false,"unique":false,"nullable":true,"reference":false,"order":1}]}

    -

  • Field ("uid": String, "name": String, "type": String, "readonly": Boolean, "unique": Boolean, "nullable": Boolean, "reference": Boolean, "order": Number)
    Beispiel für ein Field-JSONObject:

    {"uid":"KIb7Pmxm3AnJtdBWXWsJ",
 "name":"Bestand",
 "type":"Number",
 "readonly":false,
 "unique":false,
 "nullable":true,
 "reference":false,
 "order",3}

    -

  • Result ("total": Number, "title": String, "vos": Array aus 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:

    {"total":4,"title":"Artikel","vos":[
{"uid":"KIb7Pmxm3AnJtdBWXWsJ","nyVRqlqCUYvH3GNwlKrn":400,"zTc3H0vtH5o2JV82gRtg":"Schraube","pk":40000191},  {"uid":"KIb7Pmxm3AnJtdBWXWsJ","nyVRqlqCUYvH3GNwlKrn":41,"zTc3H0vtH5o2JV82gRtg":"Stuhl","pk":40000192}]}

    -

  • SearchResult ("uid": String, "name": String, "pk": Number/String, "text": String)
    Beispiel für ein SearchResult-JSONObject:

    {"uid":"KIb7Pmxm3AnJtdBWXWsJ",
 "name":"Artikel"
 "pk":40000217
 "text":"anzahl=4, lieferung=2013-06-28, lieferbar=null, name=Schrank, preis=256.17"}

    -

  • ReferenceValue ("pk": Number/String, "name": String)
    Beispiel für ein ReferenceValue-JSONObject:

    {"pk":40006894,
 "name":"Herr Rossi"}

    -

  • SubEntity ("name": String, "entity": String, "field": String)
    Beispiel für ein SubEntity-JSONObject:

    {"name":"Artikel,
 "entity":"KIb7Pmxm3AnJtdBWXWsJ",
 "field":"szU1s75TFT6kGF7l0Whj"}

    -

  • State ("pk": Number/String, "name": String, "numeral": Number, "current": Boolean, "icon": Base64-Image, optional)
    Beispiel für ein State-JSONObject:

    {"pk":40000717,
 "name":"Zugewiesen",
 "numeral":10,
 "current":true}

    -

  • Menu ("path": String, "entries": Array("uid": String, "name": String, "searchfilter": Number/String, optional))
    Beispiel für ein Menu-JSONObject:

    {"path":"Freetime",
 "entries":[{"uid":"oJeMHK7Y9A-1L7fOVrocA","name":"Ladder"},
            {"uid":"k4lF4lDOcA-nl36NMw","name":"TreeHouse"},
            {"uid":"Uzmz50InTg-yJ21HtZIA","name":"New Entity", "searchfilter":"HIb2Xmxm7AnLtdAWU8sP"}]}

Datentypen:

Um die 4 JSON-Datentypen (String, Number, Boolean, Null) weiter zu definieren, kann der Datentyp explizit in von den MetaDaten ermittelt werden, z.B. durch den Service "Field". Folgende Datentypen werden u.a. geliefert.

  • String
  • Number (bedeutet hier ganzzahlige Nummer)
  • Decimal (bedeutet hier exakte Dezimalzahl, vgl. mit java-BigDecimal)
  • Boolean
  • Date (als JSON-String)
  • weitere NuclosSpezifische Typen, werden als (JSON-String) geliefert.

HTTP-Statuscodes:

  • 200 OK
    Wird von Services ohne Return-Object (z.b. Login oder Delete) zurückgegeben, wenn die Aktion erfolgreich durchgeführt worden ist.

  • 401 Unauthorized
    Ohne oder mit ungültiger Session ID wird dieser Status gemeldet. Bei fehlgeschlagenem Login ebenfalls.

  • 403 Forbidden
    Wird eine Aktion versucht, zu der der User keine Berichtigung besitzt (z.b. Ändern einer Entität, auf der nur Leseberechtigung besteht), kommt diese Meldung.

  • 404 Not Found
    Wenn der Pfad des Services nicht korrekt ist, wird 404 zurückgegeben.

  • 406 Not Acceptable
    Bei Fehlern in den JSON-Objekten (bei POST und PUT) erscheint diese Meldung.

  • 430 Custom "CommonFatalException"
    Bei der Verarbeitung von Daten wurde eine "CommonFatalException" geworfen.


 

  • Keine Stichwörter