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.
  
  
• BusinessobjectMeta entityMeta (Path: /meta/businessobjectentity/{uid}, Method: GET, Return: JSONObject "BusinessobjectMetaentityMeta")
  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: GET/POST, Return: JSONObject "PreviewResult")
  Mit GET werden die Vorschaudaten der ersten 1000 Datensätze 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 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 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 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 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 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 "SubBusinessobjectSubentity")
  Alle abhängigen Sub-Businessobjekte (Unterformulare) 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 eines Sub-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 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.
  
  

...

• 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, "nyVRqlqCUYvH3GNwlKrn":400, "zTc3H0vtH5o2JV82gRtg":"Schraube", "_flag":"update", "_newstate": 40000344}

  -

• ValueObjectWithSubData ("_uid": String, "_pk": Number/String, "<FieldUID>": Object, beliebige Anzahl, "_subvos": Array aus ValueObjects)

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

  Codeblock
  var vo = { "_uid":"A375TFTm3AnJtdBWJtdB", "_pk":40002037, "szU1s75TFT6kGF7l0Whj":400, "_flag":"insert", "_subvos":[{"_uid":"KIb7Pmxm3AnJtdBWXWsJ","zTc3H0vtH5o2JV82gRtg":"Schraube","_pk":40000191,"_flag":"update"}, {"_uid":"KIb7Pmxm3AnJtdBWXWsJ","zTc3H0vtH5o2JV82gRtg":"Stuhl","_pk":40000192,"flag":"delete"}]}

   

  ---

   

• BusinessobjectMetaEntityMeta ("uid": String, "statemodel": Boolean, "name": String, "statemodel": Boolean, "fields": Array aus Fields, "subentities": Array aus Subentities)
  Beispiel für ein BusinessobjectEntity-JSONObject:

  Codeblock
  {"uid":"KIb7Pmxm3AnJtdBWXWsJ", "name":"Artikel", "statemodel":false, "readonly":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}] "subentities":[]}

  -

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

  -

• Result ("total": Number, "title": String, "vos": Array aus 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,"title":"Artikel","vos":[ {"uid":"KIb7Pmxm3AnJtdBWXWsJ","nyVRqlqCUYvH3GNwlKrn":400,"zTc3H0vtH5o2JV82gRtg":"Schraube","pk":40000191}, {"uid":"KIb7Pmxm3AnJtdBWXWsJ","nyVRqlqCUYvH3GNwlKrn":41,"zTc3H0vtH5o2JV82gRtg":"Stuhl","pk":40000192}]}

  -

• SearchResult ("uid": String, "name": String, "pk": Number/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"}

  -

• ReferenceValue ("pk": Number/String, "name": String)
  Beispiel für ein ReferenceValue-JSONObject:

  Codeblock
  {"pk":40006894, "name":"Herr Rossi"}

  -

• SubBusinessobjectSubEntity ("name": String, "BusinessobjectEntity": String, "field": String)
  Beispiel für ein SubBusinessobjectSubEntity-JSONObject:

  Codeblock
  {"name":"Artikel, "BusinessobjectEntity":"KIb7Pmxm3AnJtdBWXWsJ", "field":"szU1s75TFT6kGF7l0Whj"}

  -

• State ("pk": Number/String, "name": String, "numeral": Number, "current": Boolean, "icon": Base64-Image, optional)
  Beispiel für ein State-JSONObject:

  Codeblock
  {"pk":40000717, "name":"Zugewiesen", "numeral":10, "current":true}

  -

• Menu ("path": String, "entries": Array("uid": String, "name": String, "searchfilter": Number/String, optional, "icon": Base64-Image, optional))
  Beispiel für ein Menu-JSONObject:

  Codeblock
  {"path":"Freetime", "entries":[{"uid":"oJeMHK7Y9A-1L7fOVrocA","name":"Ladder"}, {"uid":"k4lF4lDOcA-nl36NMw","name":"TreeHouse"}, {"uid":"Uzmz50InTg-yJ21HtZIA","name":"New BusinessobjectEntity", "searchfilter":"HIb2Xmxm7AnLtdAWU8sP"}]}

...