Mine sisu juurde
Sursa Developers

GET/v1/folders

Kõigi kogude kaustapuude pärimine

folder_trees

Tagastab ühes vastuses kõigi nende kogude kaustapuud, kus kasutaja näeb vähemalt ühte objekti, samade nähtavusreeglitega nagu GET /v1/collections/{name}/folders ja GET /v1/collections järjekorras. Nähtavate objektideta kogu jäetakse välja. Lisaks väljale cards on igal kaustal alampuu kogusummad cards_total, sensitive_total ja top_category. Parameetriga updated_since või metadata[<key>]= sisaldab iga kogu folders sobivaid kaustu lameda loendina (children on tühi ja parent_id näitab kohta puus). Parameetriga updated_since sorditakse need kasvavalt välja updated_at järgi, seejärel välja id järgi; ilma selleta sort_key järjekorras. Sobivate kaustadeta kogud jäetakse välja.

Autentimine

Saatke API-võti päises Authorization: Authorization: Bearer <võti>.

Päringuparameetrid

  • limitinteger

    Lehe suurus. Kui limit ja cursor puuduvad, tagastatakse kogu loend; vastasel juhul kuni limit elementi ning järgmine leht antakse päistes Link (rel="next") ja X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Järgmise lehe kursor päisest X-Next-Cursor või eelmise sama filtritega vastuse väljast next_cursor; see sisaldab lehe suurust. Koos parameetriga offset: 422 validation.failed; teise loendi kursor, teiste filtritega või vigane kursor: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Ainult objektid, mille updated_at on sel hetkel või hiljem (RFC 3339 koos nihkega), sünkroonimiseks. Selle parameetriga sorditakse loend kasvavalt välja updated_at järgi, seejärel välja id järgi, ja kursor jätkab samas järjekorras. Kustutatud objekte ei loetleta: kustutamised tulevad sündmustena.

    length ≤ 512

  • metadatamap of string

    Filter välja metadata järgi: metadata[<key>]=<value> nõuab täpset vastavust. Kuni 3 tingimust ja kõik peavad sobima (?metadata[team]=support&metadata[crm_id]=A-1042). Rohkem kui 3 tingimuse või vigase võtme korral tagastatakse 400 api.metadata_invalid.

Vastused

200Edukas vastus

Vastuse päised

  • Link

    Järgmise lehe aadress, <…>; rel="next". Päise puudumine tähendab, et see on viimane leht.

  • X-Next-Cursor

    Järgmise lehe kursor parameetri cursor jaoks. Päise puudumine tähendab, et see on viimane leht.

  • RateLimit-Policy

    Kehtivad piirangud IETF-i mustandi draft-ietf-httpapi-ratelimit-headers vormingus: komadega eraldatud elemendid "<name>";q=<quota>;w=<window in seconds>. key on API-võtme päringusagedus (kvoot on tipuvaru, ajaaken on aeg selle täielikuks taastumiseks; seansi puhul on see user, ilma autentimisandmeteta ip); minute, day ja month on organisatsiooni kvoodid kalendriminutile, -päevale ja -kuule UTC järgi.

  • RateLimit

    Iga päises RateLimit-Policy oleva piirangu jääk: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Päises RateLimit-Policy oleva rangeima kirje limiit (selle, millel on kõige vähem päringuid järel).

  • X-RateLimit-Remaining

    Rangeima piirangu järgi järelejäänud päringud.

  • X-RateLimit-Reset

    Sekundid rangeima piirangu lähtestumiseni.

application/json

Objekt: FolderTreeList

array of FolderTree
  • collection_idintegerkohustuslik
  • collection_namestringkohustuslik
  • collection_titlestringkohustuslik

    Kogu kuvatav nimi.

  • permissionsarray of stringkohustuslik

    Kasutaja tegelikud õigused kogul.

  • unfiledintegerkohustuslik

    Kogu kasutajale kättesaadavad kaardid, mis ei ole üheski kaustas. Arhiveeritud kaarte ei loeta, nagu ka vaikimisi kaartide loendis.

  • foldersarray of FolderNodekohustuslik
401Autentimisandmeid ei saadetud (ei seansiküpsist ega API-võtit) või võtit ei leitud.

Vastuse päised

  • RateLimit-Policy

    Kehtivad piirangud IETF-i mustandi draft-ietf-httpapi-ratelimit-headers vormingus: komadega eraldatud elemendid "<name>";q=<quota>;w=<window in seconds>. key on API-võtme päringusagedus (kvoot on tipuvaru, ajaaken on aeg selle täielikuks taastumiseks; seansi puhul on see user, ilma autentimisandmeteta ip); minute, day ja month on organisatsiooni kvoodid kalendriminutile, -päevale ja -kuule UTC järgi.

  • RateLimit

    Iga päises RateLimit-Policy oleva piirangu jääk: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Päises RateLimit-Policy oleva rangeima kirje limiit (selle, millel on kõige vähem päringuid järel).

  • X-RateLimit-Remaining

    Rangeima piirangu järgi järelejäänud päringud.

  • X-RateLimit-Reset

    Sekundid rangeima piirangu lähtestumiseni.

application/json

Objekt: Error

429Liiga palju päringuid (`api.rate_limited`), organisatsiooni minuti-, päeva- või kuukvoot on ära kasutatud (`api.quota_exceeded`; `error.details` sisaldab välju `quota`, `limit` ja `reset_at`), organisatsiooni limiit on täis või vastuseteenus on hõivatud (`answers.engine_busy`). Oodake päises `Retry-After` antud aeg.

Vastuse päised

  • Retry-After

    Sekundite arv, mida oodata enne päringu kordamist.

  • RateLimit-Policy

    Kehtivad piirangud IETF-i mustandi draft-ietf-httpapi-ratelimit-headers vormingus: komadega eraldatud elemendid "<name>";q=<quota>;w=<window in seconds>. key on API-võtme päringusagedus (kvoot on tipuvaru, ajaaken on aeg selle täielikuks taastumiseks; seansi puhul on see user, ilma autentimisandmeteta ip); minute, day ja month on organisatsiooni kvoodid kalendriminutile, -päevale ja -kuule UTC järgi.

  • RateLimit

    Iga päises RateLimit-Policy oleva piirangu jääk: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Päises RateLimit-Policy oleva rangeima kirje limiit (selle, millel on kõige vähem päringuid järel).

  • X-RateLimit-Remaining

    Rangeima piirangu järgi järelejäänud päringud.

  • X-RateLimit-Reset

    Sekundid rangeima piirangu lähtestumiseni.

application/json

Objekt: Error

Veakoodid

Koodid, mida see lõpp-punkt võib lisaks iga päringu üldistele koodidele tagastada väljal error.code.

Sageduspiirangud

Vastustes on päised RateLimit ja RateLimit-Policy ning varasemad X-RateLimit-Limit, X-RateLimit-Remaining ja X-RateLimit-Reset. Vastuses 429 on päis Retry-After sekundites: oodake ja proovige uuesti.

← folders · API teatmik