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

  • SearchFilter (Path: /meta/searchfilter/{uid}, Method: GET, Return: JSONObject "entityMeta")
    Liefert die Metadaten des zum Suchfilter {uid} zugeordneten Businessobjekt {uid} mit ihren Feldern zurück.


  • 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/{uid}/{field}/{fk}, Method: GET, Return: JSONObject "Result")
    Lädt die Unterformulardaten eines Sub-Businessobjekts mit dem Fremdschlüssel {fk} im Feld {field}. Die Master-Entität ist {uid}. 

  • GetData (Path:/data/get/{uid}/{pk}, Method: GET, 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.

...

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

    -

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

    Codeblock
    {"name":"Artikel,
     "Entity":"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","icon":"iVBORw0KGgoAAAANSUhEUgA"},
                {"uid":"Uzmz50InTg-yJ21HtZIA","name":"New Entity", "searchfiltericon":"HIb2Xmxm7AnLtdAWU8sPiVBORw0KGgoAAAANSUhEUgA"}]}

Datentypen:

Um die 4 JSON-Datentypen (String, Number, Boolean, Null) weiter zu definieren, kann der Datentyp explizit in von den MetaDaten ermittelt werden, z.B. durch den Service "Field". Folgende Datentypen werden u.a. geliefert.

...