Paginación en SCIM
La función de paginación se utiliza para controlar un gran número de respuestas de manera más simple. Mediante la paginación, se puede establecer el parámetro de recuento para que limite el número de resultados deseados en una página. Además, permite ir fácilmente a la página anterior o a la página siguiente desde la página actual de la navegación. La siguiente tabla describe el parámetro de la solicitud de paginación, su descripción y el valor predeterminado.
cad140es
La función de paginación se utiliza para controlar un gran número de respuestas de manera más simple. Mediante la paginación, se puede establecer el parámetro de recuento para que limite el número de resultados deseados en una página. Además, permite ir fácilmente a la página anterior o a la página siguiente desde la página actual de la navegación.
La siguiente tabla describe el parámetro de la solicitud de paginación, su descripción y el valor predeterminado.
Parámetro | Descripción | Predeterminado |
startIndex | El índice basado en 1 del primer resultado de consulta. Un valor inferior a 1 DEBE interpretarse como 1. | 1 |
count | Un número entero no negativo. Especifica el número de resultados de consulta deseado por página. Por ejemplo: 10. Un valor negativo se DEBE interpretar como 0. Un valor de 0 indica que no se devolverá ningún resultado de recurso, exceptuando los resultados totales. | Ninguna. Si se especifica, el proveedor de servicios no debe devolver más resultados de los especificados, aunque devuelva menos resultados. Si no se especifica, el proveedor de servicios establece el número máximo de resultados. |
La siguiente tabla muestra los elementos de la respuesta de paginación.
Elemento | Descripción |
itemsPerPage | Un número entero no negativo. Especifica el número de resultados de consulta que se devuelven en una página de respuesta de consulta. Por ejemplo: 10. |
totalResults | Un número entero no negativo. Especifica el número total de resultados que coinciden con la consulta. Por ejemplo: 1000. |
startIndex | El índice basado en 1 del primer resultado del conjunto actual de resultados de consulta. Por ejemplo: 1. |
Ejemplo:
El ejemplo siguiente recupera los diez primeros usuarios mediante el establecimiento de startIndex en 1 y el recuento en 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":[{...}]}
Nota:
En el ejemplo anterior, para continuar con la paginación, establezca startIndex en 11 y vuelva a iniciar la recuperación. Esto es: /Users?startIndex=11&count=10.