Sintaxe de paginação

Para limitar os resultados retornados em uma solicitação de recuperação de API, HTTP GET, a maioria dos IBM® QRadar® Endpoints de API que retornam listas de recursos suportam o parâmetro de cabeçalho Range .

A sintaxe de parâmetro Range é consistente para todos os terminais que o suportam. Consulte a documentação do endpoint para determinar se o parâmetro Range se aplica a ele. Quaisquer limitações na sintaxe Range são incluídas na descrição desse endpoint.

Nota: O parâmetro Range é sempre enviado como parâmetro de cabeçalho, ao contrário dos parâmetros sort, filtere fields . Normalmente esses parâmetros são parâmetros de consulta.

Por padrão, apenas os 50 primeiros registros são retornados para o parâmetro Range na página de documentação da API interativa. É possível mudar o valor Range de um endpoint. No entanto, se você solicitar conjuntos de resultados grandes, isso poderá afetar negativamente o desempenho da página de documentação da API interativa.

Parâmetro de cabeçalho do intervalo

As solicitações de paginação são especificadas com o parâmetro de cabeçalho Range. Use a sintaxe indexada em zero a seguir:

Range: items=x-y

A resposta a uma solicitação que utiliza a paginação inclui o cabeçalho Content-Range. O cabeçalho indica o número de registros que foram retornados dentro do intervalo de conteúdo no formato a seguir:

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

Por exemplo, para retornar os 5 primeiros registros, o cabeçalho da solicitação contém o parâmetro a seguir:

"Range: items= 0-4"
O cabeçalho de resposta para essa solicitação retorna as informações a seguir:
Content-Range: items 0-4/5

Se o intervalo solicitado exceder o número de registros, todos os registros que estiverem dentro do intervalo indicado serão retornados. No exemplo a seguir, os 100 primeiros registros são solicitados:

"Range: items= 0-99"

No entanto, há apenas 12 registros no total. A resposta retorna todos os registros no intervalo indicado:

Content-Range: items 0-11/12

Se o intervalo solicitado estiver além dos limites da quantia de registros, nenhum registro será retornado. No exemplo a seguir, os 3 a 5 primeiros registros são solicitados:

"Range: items = 3-5"

No entanto, como há menos de 3 registros, nenhum registro é retornado:

Content-Range: items */3