Levels of Detail

To improve performance, not all stored data is returned by default. The level of detail returned can be controlled. This setting only applies to XML, JSON, XLS, and CSV formats. Other formats such as PDF or ISDOC are not affected. Only one detail level can be selected at a time.

The detail level is specified using the detail parameter. For listing records, the default level is summary; for a single record detail, it is full.

Example: /c/firma/adresar?detail=summary

The custom detail level allows you to select any fields to be included in the output. It is useful when you only need certain data but summary does not contain what you need. The URL syntax is special:

/c/firma/adresar?detail=custom:nazev,ic

This will export only the ID, name, and company registration number (IČO). The string custom is followed by a colon, and then a comma-separated list of fields to be exported. The id field is always exported, so it does not need to be specified. Unknown properties are ignored.

It is also possible to specify a custom detail level for object collections. Simply append a list of properties in parentheses after the collection name, as follows:

/c/firma/cenik?detail=custom:kod,sady-a-komplety(cenik,cenikSada)

This means that from the price list, only the code and the collection of sets/bundles will be exported, and for each set/bundle, only the properties cenik and cenikSada (and the ID) will be exported.

If needed, this syntax can also be nested (e.g., /c/abc/cenik.xml?detail=custom:kod,sady-a-komplety(cenik(nazev),cenikSada)&includes=/cenik/sady-a-komplety/sady-a-komplety/cenik).

Example for contact person information defined at a company's delivery address:

&includes=faktura-vydana/mistUrc/misto-urceni/kontaktOsoba&detail=custom:mistUrc(kontaktOsoba(jmeno,prijmeni,tel,mobil,email))

In addition to the basic detail level, the relations parameter can be used to control additional information. These can be combined by separating them with a comma:

Example: /c/firma/adresar?relations=vazby,prilohy

Note: fields controlled by this parameter can only be exported from ABRA Flexi. They cannot be used for importing data into ABRA Flexi. For import, data must be inserted directly into the respective table.

You can also specify that instead of just an ID in a relation, the full object is embedded.

Example: /c/firma/adresar?includes=/adresar/stat/

If you want to apply includes multiple times, separate them with a comma: ?

includes=/adresar/stat/,/adresar/stredisko/