Пређите на садржај
Sursa Developers

GET/v1/folders

Добијање стабала фолдера свих колекција

folder_trees

Враћа у једном одговору стабла фолдера свих колекција у којима корисник види бар један објекат, са истим правилима видљивости као GET /v1/collections/{name}/folders и по редоследу из GET /v1/collections. Колекција без видљивих објеката се изоставља. Поред cards, сваки фолдер има збирове за подстабло cards_total, sensitive_total и top_category. Са updated_since или metadata[<key>]= поље folders сваке колекције садржи фолдере који се поклапају као равну листу (children је празан, а parent_id даје место у стаблу). Са updated_since они су сортирани по updated_at растуће, затим по id; без њега – по редоследу sort_key. Колекције без фолдера који се поклапају се изостављају.

Аутентификација

Пошаљите API кључ у заглављу Authorization: Authorization: Bearer <кључ>.

Параметри упита

  • limitinteger

    Величина странице. Без limit и cursor враћа се цела листа; са њим – највише limit ставки, а следећа страница се наводи у заглављима Link (rel="next") и X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Курсор следеће странице из X-Next-Cursor или next_cursor претходног одговора са истим филтерима; садржи величину странице. Заједно са offset: 422 validation.failed; курсор друге листе, са другим филтерима или неисправан курсор: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Само објекти са updated_at у овом тренутку или касније (RFC 3339 са померајем), за синхронизацију. Уз њега се листа сортира по updated_at растуће, затим по id, а курсор наставља тим редоследом. Обрисани објекти се не наводе: брисања стижу као догађаји.

    length ≤ 512

  • metadatamap of string

    Филтер по metadata: metadata[<key>]=<value> – тачно подударање. До 3 услова, и сви морају да буду испуњени (?metadata[team]=support&metadata[crm_id]=A-1042). Више од 3 услова или неисправан кључ враћа 400 api.metadata_invalid.

Одговори

200Успешан одговор

Заглавља одговора

  • Link

    Адреса следеће странице, <…>; rel="next". Ако заглавља нема, ово је последња страница.

  • X-Next-Cursor

    Курсор следеће странице за параметар cursor. Ако заглавља нема, ово је последња страница.

  • RateLimit-Policy

    Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.

  • RateLimit

    Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).

  • X-RateLimit-Remaining

    Број преосталих захтева по најстрожем ограничењу.

  • X-RateLimit-Reset

    Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: FolderTreeList

array of FolderTree
  • collection_idintegerобавезно
  • collection_namestringобавезно
  • collection_titlestringобавезно

    Назив колекције за приказ.

  • permissionsarray of stringобавезно

    Стварне дозволе корисника на колекцији.

  • unfiledintegerобавезно

    Картице колекције доступне кориснику које нису ни у једном фолдеру. Архивиране картице се не рачунају, као у подразумеваном списку картица.

  • foldersarray of FolderNodeобавезно
401Акредитиви нису послати (ни колачић сесије ни API кључ) или кључ није пронађен.

Заглавља одговора

  • RateLimit-Policy

    Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.

  • RateLimit

    Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).

  • X-RateLimit-Remaining

    Број преосталих захтева по најстрожем ограничењу.

  • X-RateLimit-Reset

    Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: Error

429Превише захтева (`api.rate_limited`), квота организације за минут, дан или месец је потрошена (`api.quota_exceeded`; `error.details` садржи `quota`, `limit` и `reset_at`), достигнуто је ограничење организације или је сервис за одговоре заузет (`answers.engine_busy`). Сачекајте време наведено у заглављу `Retry-After`.

Заглавља одговора

  • Retry-After

    Број секунди које треба сачекати пре поновног покушаја захтева.

  • RateLimit-Policy

    Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.

  • RateLimit

    Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).

  • X-RateLimit-Remaining

    Број преосталих захтева по најстрожем ограничењу.

  • X-RateLimit-Reset

    Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: Error

Кодови грешака

Кодови које ова операција може да врати у error.code, поред општих кодова сваког захтева.

Ограничења учесталости

Одговори садрже заглавља RateLimit и RateLimit-Policy, као и старија X-RateLimit-Limit, X-RateLimit-Remaining и X-RateLimit-Reset. Одговор 429 садржи заглавље Retry-After у секундама: сачекајте и поновите захтев.

← folders · API референца