Paginação no SCIM
O recurso de paginação é usado para lidar com grandes respostas de maneira mais fácil. Com a paginação, você pode definir o parâmetro de contagem para limitar o número de resultados que deseja ver em uma página. Além disso, é possível mover facilmente para a página anterior e a próxima, pela página atual da navegação. A tabela a seguir descreve o parâmetro de solicitação de paginação, sua descrição e o valor padrão.
cad140br
O recurso de paginação é usado para lidar com grandes respostas de maneira mais fácil. Com a paginação, você pode definir o parâmetro de contagem para limitar o número de resultados que deseja ver em uma página. Além disso, é possível mover facilmente para a página anterior e a próxima, pela página atual da navegação.
A tabela a seguir descreve o parâmetro de solicitação de paginação, sua descrição e o valor padrão.
Parâmetro | Descrição | Padrão |
startIndex | O índice, com base em 1, do primeiro resultado de consulta. Um valor inferior a 1 DEVE ser interpretado como 1. | 1 |
count | Número inteiro não negativo. Especifica o número desejado de resultados de consulta por página desejado; por exemplo, 10. Um valor negativo deverá ser interpretado como "0". O valor "0" indica que nenhum resultado de recurso deve ser retornado, exceto pelo total de resultados. | Nenhuma. Quando especificado, o provedor de serviços não deve retornar mais nenhum resultado que não seja o especificado, embora possa retornar menos resultados. Quando não especificado, o número máximo de resultados é definido pelo provedor de serviços. |
A tabela a seguir exibe os elementos de resposta de paginação.
Elemento | Descrição |
itemsPerPage | Número inteiro não negativo. Especifica o número de resultados de consulta retornados em uma página de resposta de consulta. Por exemplo, 10. |
totalResults | Número inteiro não negativo. Especifica o número total de resultados correspondentes à consulta. Por exemplo, 1000. |
startIndex | O índice com base em 1 do primeiro resultado no conjunto atual de resultados de consulta. Por exemplo: 1 |
Exemplo:
O exemplo a seguir recupera os dez primeiros usuários com a definição de startIndex como 1 e a contagem de 10:
GET /Users?startIndex=1&count=10Host: example.comAccept: application/scim+jsonAuthorization: Bearer h480djs93hd8The response to the query above returns metadata regarding pagingsimilar to the following example:{"totalResults":100,"itemsPerPage":10,"startIndex":1,"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"Resources":[{...}]}
Observação:
no exemplo anterior, para continuar a paginação, defina startIndex como 11 e refaça a busca, ou seja, /Users?startIndex=11&count=10.