BOs lesen
Der Einstiegspunkt für diesen Service ist unter
/rest/bos
zu finden.
Beispiel aus dem Rest example: bos
Übersicht
Das Ergebnis dieses Service ist eine reine Übersicht aller lesbaren (Berechtigung des Benutzers wird angewendet) BOs.
| Key | Value |
|---|---|
| boMetaId | eindeutiger Schlüssel der BO Meta Informationen |
| name | Label des BOs |
| links/boMeta | Link zu detaillierten Meta Information zu diesem BO |
| links/bos | Link zur Ergebnisliste |
BO Metainformationen
/rest/boMetas/{boMetaId}
Die BO Metainformationen enthalten u.a. eine Auflistung der Attribute und deren Datentypen. Zum erstellen von neuen BOs ist der Link defaultGeneration wichtig (Lesen Sie hier mehr).
BO List
/rest/bos/{boMetaId}
Es werden automatisch die ersten 40 Datensätze geladen.
Die Rückgabe kann gesteuert werden, einen "QueryProvider", bekannt aus den API Regeln, gibt es jedoch leider noch nicht, ist aber in Planung.
Zur Steurung verwendbaren Request Parameter
| Parameter | Beschreibung | Standardwert | Finalisiert (wird nicht mehr geändert) |
|---|---|---|---|
| offset | Start Index der Liste. | 0 | Nein, wird zusammen mit einem QueryProvider noch überarbeitet. |
| chunksize | Anzahl der BOs. | 40 | Nein, wird zusammen mit einem QueryProvider noch überarbeitet. |
| sort | Erwartet boAttrId angeführt von asc: oder desc: Ausnahme "BOTITLE", sortiert über den angezeigten Title. | asc:BOTITLE | Nein, wird zusammen mit einem QueryProvider noch überarbeitet. |
| search | Testsuche. Sucht den übergebenen String in allen zur Anzeige gewünschten Attributen (siehe Parameter fields) | Nein, wird zusammen mit einem QueryProvider noch überarbeitet. | |
| searchFilter | Erwartet eine searchFilterId. (Die Auswahl von möglichen Suchfiltern kann über den NICHT finalisierten Service /rest/meta/searchfilters in Erfahrung gebracht werden.) | Nein, wird zusammen mit einem QueryProvider noch überarbeitet. | |
| fields | Übergeben Sie "all" damit die Attribute der zuletzt verwendeten Ergebnisliste des Java Clients verwendet werden. | Nein, wird zusammen mit einem QueryProvider noch überarbeitet. |
Überblick
Inhalte