Paginierung¶
Alle API-Ressourcen der obersten Ebene lassen sich über die list-Methoden gesammelt abrufen.
Sie können beispielsweise Mandanten, Ressourcen und verfügbare Sicherungsrichtlinien auflisten.
Diese Listenmethoden der API haben eine gemeinsame Struktur: Sie erwarten mindestens die beiden Parameter limit und page_token und geben next_page_token zurück.
Der Parameter limit legt fest, wie viele Objekte pro API-Aufruf zurückgegeben werden sollen.
Die tatsächlich zurückgegebene Anzahl kann von der angeforderten Anzahl abweichen und kleiner sein.
In manchen Fällen kann der Parameter limit auch vollständig ignoriert werden, üblicherweise wenn ein ungeeigneter Wert übergeben wird (z. B. limit = 0).
Gehen Sie erst dann davon aus, dass alle Objekte aufgelistet wurden, wenn der in der Antwort zurückgegebene Wert next_page_token leer ist.
Mit dem Parameter page_token legen Sie den Startpunkt der Auflistung fest. Übergeben Sie den Wert next_page_token aus der vorherigen Antwort, um die Auflistung nach dem zuletzt zurückgegebenen Objekt fortzusetzen.
Beispiel¶
Bei einer GET-Anforderung an den paginierten Endpunkt https://papi.afi.ai/api/v1/applications/me/installations erhalten Sie eine Antwort wie die folgende:
Übernehmen Sie den Wert von next_page_token aus dem Antworttext (Response Body) und übergeben Sie ihn bei der nächsten Anforderung an denselben Endpunkt im Abfrageparameter page_token: