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.
  
  
• Entities (Path: /meta/entities, Method: GET, Return: JSON-Array "Entity")
  Liefert alle Entitäten zurück, auf die der Benutzer lesend zugreifen kann.
  
  
• Fields (Path: /meta/fields/{uid}, Method: GET, Return: JSON-Array "Field")
  Gibt die Felder und die Metadaten der Entität {uid} zurück.
  
  
• 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.
  
  
• Update (Path: /data/update, Method: PUT, Return: JSONObject "ValueObject")
  Erwartet ein JSONObject "ValueObject" von einem existierenden Datensatz. Auf diesen wird ein UPDATE mit den übergebenen Werten ausgeführt. Falls kein Fehler auftritt, wird der Datensatz direkt aus der Datenbank nach dem UPDATE zurückgegeben.
  
  
• Insert (Path: /data/insert, Method: POST, Return: JSONObject "ValueObject")
  Erwartet ein JSONObject "ValueObject" von einem neuem Datensatz. Dieser wird mit INSERT in die Datenbank geschrieben. Falls kein Fehler auftritt, wird der Datensatz direkt aus der Datenbank nach dem INSERT zurückgegeben.
  
  
• 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.
  
  

...

• 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": "szU1s75TFT6kGF7l0Whj=asc"};

• ValueObject ("uid": String, "pk": String, "<FieldUID>": Object, beliebige Anzahl)
  Beispiel für ein gültiges ValueObject-JSONObject:

  Codeblock
  var vo = { "uid":"KIb7Pmxm3AnJtdBWXWsJ", "pk":"40000191", "nyVRqlqCUYvH3GNwlKrn":400, "zTc3H0vtH5o2JV82gRtg":"Schraube"}

   

  ---

   

   

• Entity ("uid": String, "statemodel": Boolean, "name": String)
  Beispiel für ein ValueObjectEntity-JSONObject:

  Codeblock
  {"uid":"KIb7Pmxm3AnJtdBWXWsJ", "statemodel":false, "name":"Artikel"}

• Field ("uid": String, "name": String, "type": String, "readonly": Boolean, order: Array[Integer])
  Beispiel für ein Field-JSONObject:

  Codeblock
  {"uid":"KIb7Pmxm3AnJtdBWXWsJ", "name":"Bestand", "type":"Integer", "readonly":false, "order",[3]}

• Result ("total": Number, "vos": JSONArray von 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:

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

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

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

...