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 | Nuclos ab Version | Deprecated? |
|---|---|---|---|---|
| offset | Start Index der Liste. | 0 | ||
| chunkSize | Anzahl der BOs. Max 10.000 | 40 normaler /bos Request, 5000 /bos/../subBos Request | 4.7 | < 4.7: Parameter "chunksize" |
| orderBy | Format ist angelehnt an SQL: boAttrId asc/desc - Kommasepariert | id desc | 4.7 | < 4.7: Parameter "sort" |
| search | Textsuche. Sucht den übergebenen String in allen zur Anzeige gewünschten Attributen (siehe Parameter fields) | |||
| searchFilterId | Erwartet eine searchFilterId. (Die Auswahl von möglichen Suchfiltern kann über den NICHT finalisierten Service /rest/meta/searchfilters in Erfahrung gebracht werden.) | 4.7 | < 4.7: Parameter "searchFilter" | |
| Übergeben Sie "all" damit die Attribute der zuletzt verwendeten Ergebnisliste des Java Clients verwendet werden. | JA | |||
| attributes | Kommaseparierte Liste von boAttrIds | leer = alle Attribute | 4.7 | |
| Feldbezogene Suche im Format des Java Clients | JA | |||
| where | Format ist angelehnt an SQL. Beispiel example_rest_Order_customer = 40000294 AND example_rest_Order_orderDate >= '2014-06-05' AND example_rest_Order.id IN ( SELECT example_rest_OrderPosition_order FROM example_rest_OrderPosition WHERE example_rest_OrderPosition_price > 800) | 4.7 |
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 siehe BO List.
Sub BO Detail
/bos/{boMetaId}/{boId}/subBos/{refAttrId}/{subBoId}
Siehe auch BO Detail.
Überblick
Inhalte