Versionen im Vergleich

Schlüssel

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

...

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

...

  • 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": "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:

    Codeblock
    var vo = {
    	"uid":"KIb7Pmxm3AnJtdBWXWsJ",
     	"pk":40000191,
        "flag	"nyVRqlqCUYvH3GNwlKrn":400,
     	"zTc3H0vtH5o2JV82gRtg":"insertSchraube",
     	"nyVRqlqCUYvH3GNwlKrn_flag":400"update",
     	"zTc3H0vtH5o2JV82gRtg":"Schraube"   "_newstate": 40000344}

    -

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

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

    Codeblock
    var vo = {
    	"uid":"A375TFTm3AnJtdBWJtdB",
     	"pk":40002037,
     	"flagszU1s75TFT6kGF7l0Whj":"update"400,
     	"szU1s75TFT6kGF7l0Whj_flag":400"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:

    Codeblock
    {"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:

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

    -

...