Paging-Syntax

Um die Ergebnisse zu begrenzen, die bei einer API-Abfrage zurückgegeben werden, HTTP GET, unterstützen die meisten IBM® QRadar® API-Endpunkte, die Listen von Ressourcen zurückgeben, unterstützen den Range Header-Parameter.

Die Syntax des Parameters Range ist für alle Endpunkte konsistent, die sie unterstützen. Ziehen Sie die Dokumentation für den Endpunkt zu Rate, um festzustellen, ob der Parameter Range für ihn gilt. Alle Einschränkungen für die Range -Syntax sind in der Beschreibung dieses Endpunkts enthalten.

Hinweis: Der Parameter Range wird im Gegensatz zu den Parametern sort, filterund fields immer als Headerparameter gesendet. Diese Parameter sind in der Regel Abfrageparameter.

Standardmäßig werden nur die ersten 50 Datensätze für den Parameter Range auf der interaktiven API-Dokumentationsseite zurückgegeben. Sie können den Wert für Range für einen Endpunkt ändern. Wenn Sie jedoch große Ergebnismengen anfordern, kann sich dies negativ auf die Leistung der interaktiven API-Dokumentationsseite auswirken.

Bereichsheaderparameter

Paging-Anforderungen werden mit dem Headerparameter Range angegeben. Verwenden Sie die folgende Syntax ohne Indexierung:

Range: items=x-y

Die Antwort auf eine Anforderung, die Paging verwendet, enthält den Content-Range-Header. Der Header gibt die Anzahl der Datensätze, die innerhalb des Inhaltsbereichs zurückgegeben wurden, im folgenden Format an:

Content-Range: items x-y/total number of records received

Um beispielsweise die ersten 5 Datensätze zurückzugeben, enthält der Anforderungsheader den folgenden Parameter:

"Range: items= 0-4"
Der Antwortheader für diese Anforderung gibt die folgenden Informationen zurück:
Content-Range: items 0-4/5

Wenn der angeforderte Bereich die Anzahl der Datensätze überschreitet, werden alle Datensätze zurückgegeben, die innerhalb des angegebenen Bereichs liegen. Im folgenden Beispiel werden die ersten 100 Datensätze angefordert:

"Range: items= 0-99"

Insgesamt gibt es jedoch nur 12 Datensätze. Die Antwort gibt alle Datensätze innerhalb des angegebenen Bereichs zurück:

Content-Range: items 0-11/12

Liegt der angeforderte Bereich außerhalb der Grenzen der Datensatzanzahl, werden keine Datensätze zurückgegeben. Im folgenden Beispiel werden die ersten Datensätze 3 bis 5 angefordert:

"Range: items = 3-5"

Es gibt jedoch weniger als 3 Datensätze, sodass keine Datensätze zurückgegeben werden:

Content-Range: items */3