BOs lesen
Der Einstiegspunkt für diesen Service ist unter
/bos
zu finden. Das Ergebnis dieses Service ist eine reine Übersicht aller lesbaren (Berechtigung des Benutzers wird angewendet) BOs. Die Services der pro BO enthaltenen Links boMeta und bos werden im folgenden weiter erläutert.
Beispiel aus dem Rest example: bos
BO Metainformationen
/boMetas/{boMetaId}
Gibt ein JSON Objekt für die angeforderte boMetaId zurück. 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).
Beispiel aus dem Rest example: boMetas/example_rest_Order
BO List
/bos/{boMetaId}
Gibt ein JSON Objekt für die angeforderte boMetaId zurück. Unter dem Key bos ist das Ergebnis als JSON Array zu finden. 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 verwendbare 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. |
Beispiel aus dem Rest example: bos/example_rest_Order
BO Detail
/bos/{boMetaId}/{boId}
Gibt ein JSON Objekt für die angeforderte boId zurück. Die Werte der Attribute sind unter attributes zu finden. Unterformulardaten können bei Bedarf über weitere Links nachgeladen werden. Das Objekt subBos enthält dafür jeweils ein Key-Value-Pair bestehend aus (sub-)boMetaId den Links zu den (sub-)BO Metainformationen wie auch zur Liste selbst.
Beispiel aus dem Rest example: bos/example_rest_Order/40000308
Sub BO Metainformationen
/boMetas/{boMetaId}/subBos/{refAttrId}
Beispiel aus dem Rest example: boMetas/example_rest_Order/subBos/example_rest_OrderPosition_order
Sub BO List
/bos/{boMetaId}/{boId}/subBos/{refAttrId}
Gibt ein JSON Objekt für die angeforderte refAttrId zurück. Unter dem Key bos ist das Ergebnis als JSON Array zu finden. Es werden automatisch alle Unterformulardatensätze geladen.
Zur Steurung verwendbare Request Parameter:
| Parameter | Beschreibung | Standardwert | Finalisiert (wird nicht mehr geändert) |
|---|---|---|---|
| fields | Übergeben Sie "tableview" damit die Attribute der zuletzt verwendeten Ergebnisliste des Java Clients verwendet werden. | Nein, wird zusammen mit einem QueryProvider noch überarbeitet. |
Sub BO Detail
/bos/{boMetaId}/{boId}/subBos/{refAttrId}/{subBoId}
Siehe auch BO Detail.
Überblick
Inhalte