Skip to main content
Katrs /v1 saraksta galapunkts atgriež vienu un to pašu apvalku un veic lapošanu vienādi: uz tokeniem balstītu, tikai uz priekšu.

Saraksta apvalks

string
Vienmēr "list".
array
Resursu lapa stabilā, deterministiskā secībā.
string | null
Nododiet to kā page_token nākamajā pieprasījumā, lai iegūtu nākamo lapu. null, ja citu rezultātu nav.
boolean
Norāda, vai papildus šai lapai ir pieejami vēl citi rezultāti.

Pieprasījuma parametri

integer
noklusējums:"25"
Lapas izmērs. Vesels skaitlis no 1 līdz 500. Vērtības ārpus šī diapazona atgriež 400 ar kodu invalid_request.
string
next_page_token no iepriekšējās atbildes. Pirmajai lapai to izlaidiet.
Nav nobīdes (offset) parametru, nav pārejas uz iepriekšējo lapu un nav precīzu kopējo skaitu. Lai saskaitītu kolekcijas elementus, izejiet tai cauri.
Izņēmums: GET /v1/cohorts/{id}/members atgriež ne vairāk kā 50 rindu vienā lapā, pat ja pieprasāt lielāku limit. has_more un next_page_token joprojām atspoguļo patieso Cohort atlikumu.
Autentificējieties, izmantojot jebkuru no Basic akreditācijas datu veidiem — skatiet Quickstart (apikey:secret vai secret:). Iestatiet BASE uz organizācijas reģionālo resursdatoru — skatiet Regions.

Saraksta pārlūkošana

Ielādējiet LIVING_SECURITY_API_KEY no sava noslēpumu pārvaldnieka, kā parādīts quickstart sadaļā. Šim piemēram nepieciešams entity:read; atslēgai, kas izmantota pirmā pieprasījuma pamācībā, var būt nepieciešama šī papildu atļauja. Instalējiet requests Python piemēram vai jq čaulas piemēram. Abos piemēros ir fiksēta versija, filtri netiek mainīti un novirzījumi tiek noraidīti. Tie apstājas kļūdu gadījumā un pēc 1 000 lapām, nevis ziņo par daļēju pārlūkošanu kā pabeigtu. Python lasīšanas taimauts ierobežo neaktivitāti, nevis kopējo darba ilgumu; savā integrācijā nosakiet darba termiņu. Pieprasiet lapas, līdz next_page_token ir null. Masveida lasīšanai dodiet priekšroku limit=500, lai kolekciju aptvertu ar mazāk pieprasījumiem — skatiet rate limits.

Saglabājiet filtrus nemainīgus lapošanas laikā

Lapu tokeni ir necaurredzami, parakstīti kursori. Katrs tokens ir saistīts ar organizāciju, autentificēto servisa kontu, līguma versiju un precīzu filtru kopu pieprasījumam, kas to izveidoja. Jebkuras no šīm vērtībām maiņa pārlūkošanas laikā — piemēram, type filtra pievienošana otrajā lapā — atgriež 400 ar kodu invalid_request parametram page_token:
400 Invalid request
Lai mainītu filtrus, sāciet jaunu pārlūkošanu no pirmās lapas.
Izturieties pret page_token kā pret necaurredzamu virkni: nododiet to atpakaļ tieši tādu, kādu saņēmāt. Neatšifrējiet, neglabājiet ilgtermiņā un neveidojiet tokenus — to iekšējais formāts var mainīties jebkurā laikā bez brīdinājuma.
Saraksta galapunkti noraida vaicājuma parametrus, kurus tie neatbalsta, ar 400 invalid_request, kurā norādīts parametra nosaukums. Katra galapunkta atbalstītos filtrus skatiet tā atsaucē.

Pārtrauktas vai mainīgas kolekcijas apstrāde

Šie piemēri kļūdas automātiski nemēģina atkārtot. Kļūdas 429 gadījumā ievērojiet Retry-After un izpildiet ierobežotās atkārtošanas norādes. Lasīšanas atkārtošanas laikā saglabājiet to pašu reģionu, servisa kontu, versiju, filtrus un pēdējo sekmīgi apstrādāto lapas tokenu. Akreditācijas datu maiņa nepiešķir piekļuvi: katrs pieprasījums joprojām pārbauda spēkā esošās atļaujas. Vairāku lapu lasīšana nav kolekcijas momentuzņēmums. Rindas var mainīties, kamēr jūs tai ejat cauri. Apstrādājiet resursus pēc to stabilā id un veidojiet idempotentus turpmākos ierakstus; pēc atsākšanas rinda var tikt atgriezta vēlreiz. Ja tokens tiek noraidīts, izpētiet page_token kļūdu un izlabojiet pieprasījumu, pirms sākat no pirmās lapas. Nenometiet klusējot iepriekš apstrādātos datus un nenorādiet pārtrauktu eksportu kā pabeigtu. Lai iegūtu precīzus pārskatu kopskaitus, izmantojiet atbilstošu pārskatu resursu, nevis uzskatiet dzīvā saraksta pārlūkošanu par momentuzņēmumu.