| Auszug |
|---|
|
Nuclos REST read: /bos, boMetas, boMetaId, offset, chunkSize, orderBy, search, searchFilterId, defaultGeneration. |
Language: Deutsch · English
4. Reading business objects (BO)
Read BOs via REST – /bos, meta information and lists with offset/chunkSize/orderBy/search.
| Status |
|---|
| colour | Green |
|---|
| title | Updated: Jul 2026 |
|---|
|
| Status |
|---|
| colour | Grey |
|---|
| title | applies to Nuclos 4.2026.x |
|---|
|
The entry point is /bos – an overview of all readable BOs (applying the user's permissions). Each BO offers the links boMeta and bos.
/boMetas/{boMetaId} returns a BO's attributes and data types. For creating records the defaultGeneration link is important (see create BO).
Record list
/bos/{boMetaId} returns a JSON array under the key bos (the first 40 records). The result can be controlled via request parameters:
| Parameter | Description | Default |
|---|
| offset | start index of the list. | 0 |
| chunkSize | number of BOs (max. 10,000). | 40 (or 5000 for /subBos) |
| orderBy | SQL-like: boAttrId asc/desc, comma-separated. | id desc |
| search | text search across the displayed attributes (see fields). | – |
| searchFilterId | applies a saved search filter. | – |
| Info |
|---|
|
A full QueryProvider as in the API rules is not (yet) available here – use the parameters above. |
Related pages
5. Creating a business object (BO)
Create.
Open →
6. Modifying a business object (BO)
Modify.
Open →
