Seitenhistorie

...

• 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 des Businessobjekt {uid} mit ihren Feldern zurück. Bei Entitäten Businessobjekten ohne Statusmodel werden zusätzlich noch die SubForms mitgegeben.
  
  
• PreviewData (Path: /data/preview/{uid}, Methods: GET/POST, Return: JSONObject "PreviewResult")
  Mit GET werden die Vorschaudaten der ersten 1000 Datensätze der Entität des Businessobjekt {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 des Businessobjekts {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 des Businessobjekts {uid} mit dem Primärschlüssel {pk} zurückgegeben, falls er existiert.
  
  
• GetInfo (Path:/data/getinfo}, Method: POST, Return: Return: JSONObject "Result")
  Die Preview Daten "_title" und "_info" zu einem Datensatz, der mit Post übergeben wird, werden erzeugt.
  
  
• Search (Path: /data/search/{text}, Method: GET, Return: JSON-Array "SearchResult")
  Durchsucht die Entitäten das Businessobjekt 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 des Businessobjekts {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 dem Businessobjekt {uid}. Sobald der Datensatz ordnungsgemäß entfernt wurde, wird ein HTTP Status 200 (OK) zurückgegeben.
  
  
• ReferenceList (Path: /data/referencelist/{uid}/{field}, Method: GET, Return: JSON-Array "ReferenceValue")
  Erstellt eine Liste von Reference-Werten zum Feld {field}. Momentan auf Maximal 1000 Einträge beschränkt.
  
  
• SubForms (Path: /meta/subform/{uid}/{pk}, Method: GET, Return: JSON-Array "SubEntity")
  Alle abhängigen Sub-Entitäten Businessobjekte (Unterformulare) zur Entität zum Businessobjekt {uid} und dem Datensatz {pk} werden mit dem jeweiligen Referenzfeld erzeugt.
  
  
• SubLoad (Path: /data/subload/{uid}/{field}/{fk}, Method: GET, Return: JSONObject "Result")
  Lädt die Unterformulardatan einer eines Sub-Entität Businessobjekts mit dem Fremdschlüssel {fk} im Feld {field}.
  
  
• 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 Businessobjekte bis zum Level 1 bereitgestellt.
  
  
• Tasks (Path: /meta/tasks, Method: GET, Return: JSONArray "Menu")
  Das Menü bestehend aus Tasks (Entitäten Businessobjekte mit Suchfilter) in der Sprache des angemeldet Benutzers. Hinweis: Momentan werden nur Menüeinträge für Entitäten Businessobjekten bis zum Level 1 bereitgestellt.
  
  

...

• 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äteines Businessobjekts, 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.
  
  

...