Saltar a contenido

Paginación

Todos los recursos de nivel superior de la API permiten la obtención masiva mediante los métodos «list» de la API. Por ejemplo, puede listar inquilinos, recursos y políticas de copia de seguridad disponibles. Estos métodos «list» comparten una estructura común: aceptan al menos dos parámetros, limit y page_token, y devuelven next_page_token.

El parámetro limit define cuántos objetos se deben devolver en una sola llamada a la API. Tenga en cuenta que el número específico de objetos devueltos puede diferir del solicitado y ser inferior. Además, en algunos casos el parámetro limit puede ignorarse por completo, normalmente cuando se proporciona un valor limit inadecuado (por ejemplo, limit = 0). Nunca debe suponer que se han listado todos los objetos hasta que el valor next_page_token devuelto por la solicitud esté vacío.

El parámetro page_token define un punto de partida para el listado y permite continuar desde el último objeto devuelto por una llamada anterior a la API, identificado mediante el valor de respuesta next_page_token.

Ejemplo

Al realizar una solicitud GET al punto de conexión paginado https://papi.afi.ai/api/v1/applications/me/installations, recibirá una respuesta similar a esta:

{
  "items": [...],
  "next_page_token": "next-page-id"
}

Para obtener la página siguiente de resultados, tome el valor next_page_token del cuerpo de la respuesta y proporciónelo como valor de la clave page_token en una consulta al mismo punto de conexión:

https://papi.afi.ai/api/v1/applications/me/installations?page_token=next-page-id