To increase speed, not all data we track is returned by default. The level of detail of the data can be controlled. This list is only relevant for the XML, JSON, XLS, and CSV formats. Other formats such as PDF or ISDOC are not affected by this. Only one level can be selected at a time.
The level of detail is determined by the detail parameter. For listing records, the default level is summary; for a record detail, it is full.
Example: /c/firma/adresar?detail=summary
Code | Name | Description |
| Identifier | Only the record's primary key |
| Overview | Basic overview such as |
| Full detail | An overview of all the items contained in the base record. |
| Custom detail | Only |
Custom level of detail
The custom level of detail lets you select any items you want to display. This is useful if you only need certain data, but summary doesn't contain what you need. The notation in the URL is special:
/c/firma/adresar?detail=custom:nazev,ic
This will export only the ID, name, and company ID (IČO). After the string custom comes a colon, followed by a comma-separated list of items to export. The id item is always exported, so it doesn't need to be listed. Unknown properties are ignored.
💡 detail=custom:… is the fastest option — objects you don't specify are not loaded from the database, which eliminates many SQL queries and reduces the response size.
Nested collections
You can also specify a custom level of detail for collections of objects. Simply add a list of properties in parentheses after the collection name, like this:
/c/firma/cenik?detail=custom:kod,sady-a-komplety(cenik,cenikSada)
This means that only the code and the collection of sets/bundles will be exported from the price list, with only the cenik and cenikSada properties (and, of course, the ID) exported for each set/bundle.
If needed, this notation can also be nested:
/c/abc/cenik.xml?detail=custom:kod,sady-a-komplety(cenik(nazev),cenikSada)&includes=/cenik/sady-a-komplety/sady-a-komplety/cenik
Example for information about a contact person defined at the company's delivery address:
&includes=faktura-vydana/mistUrc/misto-urceni/kontaktOsoba&detail=custom:mistUrc(kontaktOsoba(jmeno,prijmeni,tel,mobil,email))
The relations parameter
In addition to the basic level of detail, the relations parameter can be used to control other information as well. These can be combined by separating them with a comma.
Example: /c/firma/adresar?relations=vazby,prilohy
Code | Name |
| Links between documents |
| Attachments |
| Stock cards (for price lists) |
| Document items |
⚠️ Items controlled by this listing can only be exported from ABRA Flexi. They cannot be used for importing into ABRA Flexi. For import, data must be inserted directly into the corresponding table.
The includes parameter
You can also specify that the entire object be inserted in place of just the ID in a relation.
/c/firma/adresar?includes=/adresar/stat/
If you want to apply includes multiple times, separate them with a comma:
/c/firma/adresar?includes=/adresar/stat/,/adresar/stredisko/