Nuclos REST lesen: /bos, boMetas, boMetaId, offset, chunkSize, orderBy, search, searchFilterId, defaultGeneration. |
Sprache: Deutsch · English
BOs über REST lesen – /bos, Metainformationen und Listen mit offset/chunkSize/orderBy/search.
Auf dieser Seite |
Einstiegspunkt ist /bos – eine Übersicht aller lesbaren BOs (unter Anwendung der Benutzerberechtigung). Pro BO gibt es die Links boMeta und bos.
/boMetas/{boMetaId} liefert die Attribute und Datentypen eines BO. Für das Anlegen ist der Link defaultGeneration wichtig (siehe BO anlegen).
/bos/{boMetaId} liefert unter dem Key bos ein JSON-Array (die ersten 40 Datensätze). 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 (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. | – |
Einen vollwertigen |