Pagination¶
Toutes les ressources de premier niveau de l’API peuvent être obtenues par lots au moyen des méthodes list.
Vous pouvez, par exemple, répertorier les locataires, les ressources et les stratégies de sauvegarde disponibles.
Ces méthodes suivent 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 à renvoyer par appel API.
Le nombre d’objets renvoyés peut toutefois différer du nombre demandé, et notamment être inférieur.
Dans certains cas, le paramètre limit peut aussi être ignoré, généralement lorsqu’une valeur inappropriée est transmise (par exemple, limit = 0).
Ne considérez la liste comme complète que lorsque la réponse renvoie une valeur next_page_token vide.
Le paramètre page_token indique où reprendre la liste. Transmettez la valeur next_page_token de la réponse précédente pour continuer après le dernier objet renvoyé.
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, prenez la valeur next_page_token dans le corps de la réponse et transmettez-la au même point de terminaison dans le paramètre de requête page_token :