Sintaxis de paginación

Para limitar los resultados devueltos en una solicitud de recuperación de la API, HTTP GET, la mayoría de los IBM® QRadar® API que devuelven listas de recursos admiten el parámetro de encabezado Range .

La sintaxis del parámetro Range es coherente para todos los puntos finales que lo soportan. Consulte la documentación del punto final para determinar si el parámetro Range se aplica a él. Las limitaciones de la sintaxis de Range se incluyen en la descripción de ese punto final.

Nota: El parámetro Range siempre se envía como parámetro de cabecera, a diferencia de los parámetros sort, filtery fields . Estos parámetros suelen ser parámetros de consulta.

De forma predeterminada, sólo se devuelven los primeros 50 registros para el parámetro Range en la página de documentación de la API interactiva. Puede modificar el valor de Range para un punto final. Sin embargo, si solicita conjuntos de resultados grandes, puede afectar negativamente al rendimiento de la página de documentación de la API interactiva.

Parámetro de cabecera de rango

Las solicitudes de paginación se especifican con el parámetro de cabecera Range . Utilice la sintaxis de indexación cero siguiente:

Range: items=x-y

La respuesta a una solicitud que emplea paginación incluye la cabecera Content-Range. La cabecera indica el número de registros que se han devuelto dentro del rango de contenido en el formato siguiente:

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

Por ejemplo, para devolver los primeros 5 registros, la cabecera de solicitud contiene el parámetro siguiente:

"Range: items= 0-4"
La cabecera de respuesta para esa solicitud devuelve la información siguiente:
Content-Range: items 0-4/5

Si el rango solicitado supera el número de registros, se devuelven todos los registros que están dentro del rango indicado. En el ejemplo siguiente, se solicitan los primeros 100 registros:

"Range: items= 0-99"

Sin embargo, solo hay 12 registros en total. La respuesta devuelve todos los registros dentro del rango indicado:

Content-Range: items 0-11/12

Si el rango solicitado está más allá de los límites de la cantidad de registros, no se devolverá ningún registro. En el ejemplo siguiente, se solicitan los primeros registros de 3 a 5 registros:

"Range: items = 3-5"

Sin embargo, hay menos de 3 registros y, por lo tanto, no se devuelven registros:

Content-Range: items */3