Seitenhistorie

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.

...

• Login (Path: /login, Method: POST, Return: String)
  Erwartet ein Webformular mit den Keys "username" und "password" (und optional "locale"), 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. Login ist der einzige Teilservice, der keine Session ID benötigt. 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.
  
  
• Entities (Path: /meta/entities, Method: GET, Return: JSON-Array)
  Liefert alle Stammentitäten zurück, auf die der Benutzer lesend zugreifen kann.
  
  
• LoadData (Paths: /data/load/{uid}, /data/load/{uid}/{offset}, Method: GET, Return: JSON-Array)
  Die ersten 1000 Datensätze der Entität {uid} werden geladen. Falls die Option {offset} gegeben ist, wird ab diesem Datensatz begonnen.
  
  
• Search (Path: /data/search/{text}, Method: GET, Return: JSON-Array)
  Durchsucht die Entität nach dem Suchtext {text} mit Hilfe des Lucene-Indexes.