- Start
- API-Referenz
- API-Dokumentation (XML/ JSON)
- Objekte
- Allgemeine Objekte
Objekt View
Funktion
Das Objekt View legt den Umfang des Ergebnisses einer Suchanfrage fest.
Beschreibung
| JSON Keyword | XML Keyword | Häufigkeit | Typ | Format | Beschreibung |
|---|---|---|---|---|---|
| offset | offset | 0 - 1 | string | integer (int 32) | Gibt an, ab dem wievielten Objekt die Liste angezeigt werden soll. |
| children | children | 0 - 1 | boolean | Unterbenutzer abfragen. Mögliche Werte:
Vorgabewert = false Für XML können auch 0 (false) und 1 (true) verwendet werden. | |
| limit | limit | 0 - 1 | string | integer (int2) | Maximale Anzahl der anzuzeigenden Objekte |
| from | from | 0 - 1 | string | date-time | Start Datum - Wird bei Historischen Task benötigt. Beispiel: e.g. 2021-01-01 00:00:00 |
| to | to | 0 - 1 | string | date-time | End Datum - Wird bei Historischen Task benötigt. Beispiel: e.g. 2022-01-01 00:00:00 |
Beispiel
"view": {
"children": 1,
"limit": 10
},
<view>
<limit>10</limit>
<offset>0</offset>
<children>0</children>
</view>