Seitenhistorie
...
| Auszug |
|---|
...
|
...
|
BOs lesen
Der Einstiegspunkt für diesen Service ist unter
| Codeblock |
|---|
/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
Nuclos REST lesen: /bos, boMetas, boMetaId, offset, chunkSize, orderBy, search, searchFilterId, defaultGeneration. |
Sprache: Deutsch · English
4. Businessobjekte (BO) lesen
BOs über REST lesen – /bos, Metainformationen und Listen mit offset/chunkSize/orderBy/search.
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Auf dieser Seite
|
Einstiegspunkt ist /bos – eine Übersicht aller lesbaren BOs (unter Anwendung der Benutzerberechtigung). Pro BO gibt es die Links boMeta und bos.
Metainformationen
...
/boMetas/{boMetaId}
...
liefert die Attribute und Datentypen eines BO. Für das Anlegen ist der Link defaultGeneration wichtig (
...
siehe BO anlegen).
Beispiel aus dem Rest example: boMetas/example_rest_Order
BO List
...
Datensatzliste
/bos/{boMetaId}
...
liefert unter dem Key bos
...
ein JSON
...
-Array (die ersten 40 Datensätze
...
).
...
Die Rückgabe kann gesteuert werden, einen "QueryProvider", bekannt aus den API Regeln, gibt es jedoch leider noch nicht, ist aber in Planung.
...
Die Rückgabe lässt sich per Request-Parameter steuern:
| Parameter | Beschreibung |
|---|
...
| Standard | ||
|---|---|---|
| offset | Start-Index der Liste. | 0 |
| chunkSize | Anzahl der BOs (max. |
...
| 10.000). | 40 |
...
5000 /bos/../subBos Request
...
| (bzw. 5000 bei /subBos) | |
| orderBy | SQL-nah |
...
: boAttrId asc/desc |
...
| , kommasepariert. | id desc |
...
| search | Textsuche |
...
| über die anzuzeigenden Attribute (siehe |
...
fields). |
...
| – |
...
| searchFilterId | wendet einen gespeicherten Suchfilter an. | – |
| Info | ||
|---|---|---|
| ||
Einen vollwertigen |
Verwandte Seiten
.
(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" fieldsÜbergeben Sie "all" damit die Attribute der zuletzt verwendeten Ergebnisliste des Java Clients verwendet werden. attributes Kommaseparierte Liste von boAttrIds leer = alle Attribute 4.7 searchConditionFeldbezogene Suche im Format des Java Clients JA where
4.7
Siehe auch BO Detail.
(Die Auswahl von möglichen Suchfiltern kann über den NICHT finalisierten Service /rest/meta/searchfilters in Erfahrung gebracht werden.)
JA
Format ist angelehnt an SQL.
| Codeblock | ||||
|---|---|---|---|---|
| ||||
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) |
Beispiel aus dem Rest example: bos/example_rest_Order
BO Detail
| Codeblock |
|---|
/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
| Codeblock |
|---|
/boMetas/{boMetaId}/subBos/{refAttrId} |
Beispiel aus dem Rest example: boMetas/example_rest_Order/subBos/example_rest_OrderPosition_order
Sub BO List
| Codeblock |
|---|
/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
| Codeblock |
|---|
/bos/{boMetaId}/{boId}/subBos/{refAttrId}/{subBoId} |
Überblick
Inhalte