Pagination¶
Toutes les ressources API de premier niveau peuvent être répertoriées en bloc à l’aide des méthodes API « list ».
Vous pouvez, par exemple, répertorier les locataires, les ressources et les stratégies de sauvegarde disponibles.
Ces méthodes API « list » partagent une structure commune : elles acceptent au moins deux paramètres, limit et page_token, et renvoient next_page_token.
Le paramètre limit définit le nombre d’objets que doit renvoyer un même appel d’API.
Notez que le nombre exact d’objets renvoyés peut différer du nombre demandé et lui être inférieur.
Dans certains cas, le paramètre limit peut également être totalement ignoré, généralement lorsqu’une valeur limit inappropriée est transmise (par exemple, limit = 0).
Ne considérez jamais que tous les objets ont été répertoriés tant que la valeur next_page_token renvoyée par la requête n’est pas vide.
Le paramètre page_token définit le point de départ de la liste et permet de poursuivre celle-ci à partir du dernier objet renvoyé par un appel d’API précédent, identifié par la valeur next_page_token de la réponse.
Exemple¶
Lorsque vous envoyez une requête GET au point de terminaison paginé https://papi.afi.ai/api/v1/applications/me/installations, vous recevez une réponse semblable à celle-ci :
Pour obtenir la page de résultats suivante, relevez la valeur next_page_token dans le corps de la réponse et transmettez-la comme valeur de la clé page_token dans une requête adressée au même point de terminaison :