Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

...

  • 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 Businessobjekte bis zum Level 1 bereitgestellt.

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

  • EntityMeta (Path: /meta/entity/{uid}, Method: GET, Return: JSONObject "entityMeta")
    Liefert die Metadaten des Businessobjekt {uid} mit ihren Feldern zurück. Bei Businessobjekten ohne Statusmodel werden zusätzlich noch die SubForms mitgegeben.

  • PreviewData (Path: /data/preview/{uid}, Methods: POST, Return: JSONObject "PreviewResult")
    Lädt eine Vorschau der Daten zu einem Businessobjekt {uid}. Mit POST wird ein Filter für die Daten (s. JSON-Spezifikationen) übergeben.

  • SubLoad (Path: /data/subload/{subform}/{field}/{fk}, Method: GET, Return: JSONObject "Result")
    Lädt die Unterformulardaten eines Sub-Businessobjekts mit dem Fremdschlüssel {fk} im Feld {field}.

  • GetData (Path:/data/get/{uid}/{pk}, Method: GET, Return: Return: JSONObject "Result", Optional Path:/data/get/{uid}/{pk}/{uchash})
    Es wird der Datensatz des Businessobjekts {uid} mit dem Primärschlüssel {pk} zurückgegeben, falls er existiert. Optional kann mit {uchash} ein Hashwert, welcher mit dem letzt-gelesenen Datensatz geliefert worden ist, mitgegeben wird. Bei Übereinstimmung der Hashwerte werden keine neue Metadaten über Felder und Unterformulare geliefert.

  • SubGetData (Path:/data/subget/{uid}/{subform}/{pk}, Method: GET, Return: Return: JSONObject "Result")
    Es wird der Datensatz des Unterformulars {subform} mit dem Primärschlüssel {pk} zum Hauptformular des Businessobjekts {uid} zurückgegeben, falls er existiert.

  • GetInfo (Path:/data/getinfo/{uid}, Method: POST, Return: Return: JSONObject "Result")
    Die Preview Daten "_title" und "_info" zu einem Unterformular-Datensatz, der mit Post übergeben wird, werden erzeugt. {uid} ist das Businessobjekt des Hauptformulars

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

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

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

  • 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.

 

  • SubOpen (Path: /data/subopen/{uid}/{subform}/{pk}/{file}, Method: GET, Return APPLICATION_OCTET_STREAM
  • FieldGet (Path: /data/fieldget/{field}|{pk}, Method: GET, Return JSONObject "Result"
  • VLPData (Path: /data/vlpdata/{field}, Method: POST, Return JSON-Array "ValueId")
  • SubLoad(Path: /data/subload/{subform}/{field}/{fk}, Method: POST, Return: JSONObject "Result")



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"};

    -

...