/v1-lijsteindpunt retourneert dezelfde envelop en pagineert op dezelfde
manier: tokengebaseerd en uitsluitend voorwaarts.
De lijstenvelop
string
Altijd
"list".array
De pagina met resources, in een stabiele, deterministische volgorde.
string | null
Geef dit mee als
page_token bij het volgende verzoek om de volgende pagina op te halen.
null wanneer er geen resultaten meer zijn.boolean
Geeft aan of er na deze pagina nog meer resultaten bestaan.
Verzoekparameters
integer
standaard:"25"
Paginagrootte. Een geheel getal van 1 tot en met 500. Waarden buiten dit bereik leiden tot een
400 met de code invalid_request.string
De
next_page_token uit het vorige antwoord. Laat deze parameter weg voor de eerste pagina.Uitzondering:
GET /v1/cohorts/{id}/members retourneert maximaal 50 rijen per
pagina, ook wanneer u een hogere limit opgeeft. has_more en
next_page_token geven nog steeds het werkelijke restant van de Cohort weer.apikey:secret of secret:).
Stel BASE in op de regionale host van de organisatie; zie
Regio’s.
Een lijst doorlopen
LaadLIVING_SECURITY_API_KEY uit uw secretmanager, zoals in de Quickstart.
Dit voorbeeld vereist entity:read; voor de sleutel die is gebruikt voor de handleiding voor het eerste verzoek
kan deze aanvullende machtiging nodig zijn. Installeer requests voor Python of jq voor het shellvoorbeeld.
Beide voorbeelden leggen een versie vast, laten filters ongewijzigd en weigeren
redirects. Ze stoppen bij fouten en na 1.000 pagina’s, in plaats van een
gedeeltelijke doorloop als volledig te rapporteren. De leestimeout van Python begrenst inactiviteit, niet de totale
duur van de taak; stel in uw integratie een deadline voor de taak in.
Vraag pagina’s op totdat next_page_token gelijk is aan null. Geef de voorkeur aan limit=500 voor bulk-
leesacties, zodat u de verzameling met minder verzoeken doorloopt; zie
rate limits.
Houd filters stabiel tijdens het pagineren
Paginatokens zijn ondoorzichtige, ondertekende cursors. Elk token is gebonden aan de organisatie, het geauthenticeerde serviceaccount, de contractversie en de exacte filterset van het verzoek waarmee het is aangemaakt. Als u een van deze tijdens een doorloop wijzigt, bijvoorbeeld door op de tweede pagina eentype-filter toe te voegen, ontvangt u een 400 met de code
invalid_request voor de parameter page_token:
400 Invalid request
Lijsteindpunten weigeren queryparameters die ze niet ondersteunen met een
400
invalid_request waarin de parameter wordt genoemd. Raadpleeg de referentie van elk eindpunt voor
de ondersteunde filters.Een onderbroken of veranderende verzameling afhandelen
Deze voorbeelden proberen fouten niet automatisch opnieuw. Houd bij429 rekening met Retry-After
en volg de begrensde richtlijnen voor opnieuw proberen. Gebruik bij het opnieuw proberen van een leesactie dezelfde
regio, hetzelfde serviceaccount, dezelfde versie, dezelfde filters en het laatst succesvol verwerkte
paginatoken. Het wijzigen van referenties verleent geen toegang:
elk verzoek controleert nog steeds de actuele machtigingen.
Een leesactie over meerdere pagina’s is geen momentopname van de verzameling. Rijen kunnen wijzigen terwijl
u de verzameling doorloopt. Verwerk resources op basis van hun stabiele id en maak downstream-
schrijfacties idempotent; na een herstart kan een rij opnieuw worden geretourneerd. Als een token wordt geweigerd,
controleer dan de page_token-fout en corrigeer het verzoek voordat u opnieuw begint vanaf
de eerste pagina. Verwijder eerder verwerkte gegevens niet stilzwijgend en markeer een
onderbroken export niet als voltooid. Gebruik voor exacte rapportagetotalen de juiste
rapportageresource in plaats van een live lijstdoorloop als momentopname te beschouwen.
