QueryRequestOptions interface
Die Optionen für die Abfrageauswertung
Eigenschaften
allow |
Gilt nur für Abfragen auf Mandanten- und Verwaltungsgruppenebene, um zu entscheiden, ob Teilbereiche für das Ergebnis zugelassen werden sollen, falls die Anzahl der Abonnements die zulässigen Grenzwerte überschreitet. Standardwert: False |
result |
Definiert, in welchem Format das Abfrageergebnis zurückgegeben wird. Mögliche Werte sind: "table", "objectArray". Standardwert: "objectArray". |
skip | Die Anzahl der Zeilen, die am Anfang der Ergebnisse übersprungen werden sollen. Überschreibt den Offset der nächsten Seite, wenn |
skip |
Fortsetzungstoken für die Paginierung, das die Größe und den Offset der nächsten Seite sowie den Kontext der Abfrage erfasst. |
top | Die maximale Anzahl von Zeilen, die die Abfrage zurückgeben soll. Überschreibt die Seitengröße, wenn |
Details zur Eigenschaft
allowPartialScopes
Gilt nur für Abfragen auf Mandanten- und Verwaltungsgruppenebene, um zu entscheiden, ob Teilbereiche für das Ergebnis zugelassen werden sollen, falls die Anzahl der Abonnements die zulässigen Grenzwerte überschreitet. Standardwert: False
allowPartialScopes?: boolean
Eigenschaftswert
boolean
resultFormat
Definiert, in welchem Format das Abfrageergebnis zurückgegeben wird. Mögliche Werte sind: "table", "objectArray". Standardwert: "objectArray".
resultFormat?: ResultFormat
Eigenschaftswert
skip
Die Anzahl der Zeilen, die am Anfang der Ergebnisse übersprungen werden sollen. Überschreibt den Offset der nächsten Seite, wenn $skipToken
die Eigenschaft vorhanden ist.
skip?: number
Eigenschaftswert
number
skipToken
Fortsetzungstoken für die Paginierung, das die Größe und den Offset der nächsten Seite sowie den Kontext der Abfrage erfasst.
skipToken?: string
Eigenschaftswert
string
top
Die maximale Anzahl von Zeilen, die die Abfrage zurückgeben soll. Überschreibt die Seitengröße, wenn $skipToken
die Eigenschaft vorhanden ist.
top?: number
Eigenschaftswert
number