Paginierung

Ressourcenlisten werden seitenweise über die list-Methoden der API abgerufen. 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 limit-Wert übergeben wird (z. B. limit = 0). Gehen Sie erst dann davon aus, dass alle Objekte aufgelistet wurden, wenn der von der Anfrage zurückgegebene Wert next_page_token leer ist.

Der Parameter page_token legt einen Startpunkt für die Auflistung fest. Damit können Sie die Auflistung ab dem letzten Objekt fortsetzen, das ein vorheriger API-Aufruf zurückgegeben hat und das durch den Antwortwert next_page_token identifiziert wird.

Beispiel

Bei einer GET-Anfrage an den paginierten Endpunkt https://papi.afi.ai/api/v1/applications/me/installations erhalten Sie eine Antwort wie die folgende:

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

Übergeben Sie den Wert von next_page_token bei der nächsten Anfrage an denselben Endpunkt im Abfrageparameter page_token:

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