POST/v1/collections/{name}/folders

Vytvořit složku

create_folder

Vytvoří složku v kořeni kolekce (vyžaduje COLLECTION_EDIT_CARDS ke kolekci) nebo uvnitř parent_id (vyžaduje toto oprávnění k nadřazené složce). prev_sibling_id určuje pozici mezi sousedními prvky: first, last (výchozí) nebo ID sousedního prvku, za kterým má složka následovat. Hloubka je nejvýše tři úrovně (folders.depth_exceeded). color a icon určují vzhled složky; hodnota mimo povolený seznam vrací folders.appearance_invalid.

Autentizace

Odešlete klíč API v hlavičce Authorization: Authorization: Bearer <klíč>.

Parametry cesty

namestringpovinné
Název kolekce nebo její id ve tvaru id:<number> (id:3). Segment složený jen z číslic je název.

Parametry hlavičky

Idempotency-Keystring
Klíč pro bezpečné opakování zápisu: 1 až 255 tisknutelných znaků ASCII; doporučuje se UUID v4 pro každou logickou operaci. Opakování se stejným klíčem do 24 hodin operaci znovu nespustí: vrátí uloženou odpověď (stav, hlavičky a tělo) s hlavičkou Idempotency-Replayed: true. Stejný klíč s jinou metodou, cestou, Content-Type nebo tělem vrací 409 api.idempotency_mismatch; dokud první požadavek ještě běží, vrací 409 api.idempotency_in_progress s Retry-After: 1. Po odpovědi 5xx nebo 429 se klíč uvolní a opakování operaci spustí znovu. Klíč platí v rámci organizace a volajícího (klíč API, uživatel nebo klíč vlastního zdroje).
length ≥ 1, length ≤ 255

Tělo požadavku

application/json

Objekt: FolderCreate

titlestringpovinné
length ≥ 1, length ≤ 200
parent_idstring | null
prev_sibling_idFolderPosition
colorFolderColor | null
Barva složky z palety. Pokud chybí nebo je null, barva je automatická.
iconFolderIcon | null
Ikona složky. Pokud chybí nebo je null, ikona je automatická.
metadataMetadataPatch

Odpovědi

201Složka vytvořena

Hlavičky odpovědi

RateLimit-Policy
Platné limity ve formátu návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddělené čárkou "<name>";q=<quota>;w=<window in seconds>. key je četnost požadavků klíče API (kvóta je nárazová špička, okno je doba jejího úplného obnovení; pro relaci je to user, bez přihlašovacích údajů ip); minute, day a month jsou kvóty organizace na kalendářní minutu, den a měsíc v UTC.
RateLimit
Kolik zbývá z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit nejpřísnější položky v RateLimit-Policy (té, ve které zbývá nejméně požadavků).
X-RateLimit-Remaining
Počet požadavků, které zbývají v rámci nejpřísnějšího limitu.
X-RateLimit-Reset
Počet sekund do obnovení nejpřísnějšího limitu.
Idempotency-Replayed
true znamená, že jde o znovu vrácenou uloženou odpověď pro tento Idempotency-Key: operace se znovu nespustila.

application/json

Objekt: Folder

idstringpovinné
collection_idintegerpovinné
parent_idstring | nullpovinné
titlestringpovinné
sort_keystringpovinné
created_byinteger | nullpovinné
created_atstring (date-time)povinné
updated_atstring (date-time)povinné
colorFolderColor | nullpovinné
Barva složky z palety, stejná pro všechny uživatele. null znamená automaticky: klient vybere barvu palety podle názvu.
iconFolderIcon | nullpovinné
Ikona složky, stejná pro všechny uživatele. null znamená automaticky, podle top_category uzlu stromu.
permissionsarray of stringpovinné
metadataMetadata

400Požadavek je neplatný: hodnota parametru nebo stav objektu akci neumožňuje (`detail` je zpráva).

Hlavičky odpovědi

RateLimit-Policy
Platné limity ve formátu návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddělené čárkou "<name>";q=<quota>;w=<window in seconds>. key je četnost požadavků klíče API (kvóta je nárazová špička, okno je doba jejího úplného obnovení; pro relaci je to user, bez přihlašovacích údajů ip); minute, day a month jsou kvóty organizace na kalendářní minutu, den a měsíc v UTC.
RateLimit
Kolik zbývá z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit nejpřísnější položky v RateLimit-Policy (té, ve které zbývá nejméně požadavků).
X-RateLimit-Remaining
Počet požadavků, které zbývají v rámci nejpřísnějšího limitu.
X-RateLimit-Reset
Počet sekund do obnovení nejpřísnějšího limitu.

application/json

Objekt: Error

401Nebyly odeslány žádné přihlašovací údaje (ani cookie relace, ani klíč API), nebo klíč nebyl nalezen.

Hlavičky odpovědi

RateLimit-Policy
Platné limity ve formátu návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddělené čárkou "<name>";q=<quota>;w=<window in seconds>. key je četnost požadavků klíče API (kvóta je nárazová špička, okno je doba jejího úplného obnovení; pro relaci je to user, bez přihlašovacích údajů ip); minute, day a month jsou kvóty organizace na kalendářní minutu, den a měsíc v UTC.
RateLimit
Kolik zbývá z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit nejpřísnější položky v RateLimit-Policy (té, ve které zbývá nejméně požadavků).
X-RateLimit-Remaining
Počet požadavků, které zbývají v rámci nejpřísnějšího limitu.
X-RateLimit-Reset
Počet sekund do obnovení nejpřísnějšího limitu.

application/json

Objekt: Error

403Akce není povolena: role nestačí, chybí přístup ke kolekci nebo kartě, požadavek běží v režimu „View as“, nebo je organizace pozastavená či smazaná (`detail` je objekt s `code: org_suspended | org_deleted`).

Hlavičky odpovědi

RateLimit-Policy
Platné limity ve formátu návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddělené čárkou "<name>";q=<quota>;w=<window in seconds>. key je četnost požadavků klíče API (kvóta je nárazová špička, okno je doba jejího úplného obnovení; pro relaci je to user, bez přihlašovacích údajů ip); minute, day a month jsou kvóty organizace na kalendářní minutu, den a měsíc v UTC.
RateLimit
Kolik zbývá z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit nejpřísnější položky v RateLimit-Policy (té, ve které zbývá nejméně požadavků).
X-RateLimit-Remaining
Počet požadavků, které zbývají v rámci nejpřísnějšího limitu.
X-RateLimit-Reset
Počet sekund do obnovení nejpřísnějšího limitu.

application/json

Objekt: Error

404Objekt neexistuje nebo vám není dostupný. API nepotvrzuje, že objekt s omezeným přístupem existuje.

Hlavičky odpovědi

RateLimit-Policy
Platné limity ve formátu návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddělené čárkou "<name>";q=<quota>;w=<window in seconds>. key je četnost požadavků klíče API (kvóta je nárazová špička, okno je doba jejího úplného obnovení; pro relaci je to user, bez přihlašovacích údajů ip); minute, day a month jsou kvóty organizace na kalendářní minutu, den a měsíc v UTC.
RateLimit
Kolik zbývá z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit nejpřísnější položky v RateLimit-Policy (té, ve které zbývá nejméně požadavků).
X-RateLimit-Remaining
Počet požadavků, které zbývají v rámci nejpřísnějšího limitu.
X-RateLimit-Reset
Počet sekund do obnovení nejpřísnějšího limitu.

application/json

Objekt: Error

409Stav objektu akci neumožňuje, například kvůli duplicitě, probíhajícímu indexování nebo úloze, která už je zpracovaná.

Hlavičky odpovědi

RateLimit-Policy
Platné limity ve formátu návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddělené čárkou "<name>";q=<quota>;w=<window in seconds>. key je četnost požadavků klíče API (kvóta je nárazová špička, okno je doba jejího úplného obnovení; pro relaci je to user, bez přihlašovacích údajů ip); minute, day a month jsou kvóty organizace na kalendářní minutu, den a měsíc v UTC.
RateLimit
Kolik zbývá z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit nejpřísnější položky v RateLimit-Policy (té, ve které zbývá nejméně požadavků).
X-RateLimit-Remaining
Počet požadavků, které zbývají v rámci nejpřísnějšího limitu.
X-RateLimit-Reset
Počet sekund do obnovení nejpřísnějšího limitu.

application/json

Objekt: Error

422Chyba validace: tělo nebo parametry neodpovídají schématu (`detail` je seznam chyb validace), nebo je hodnota parametru mimo povolený rozsah (`detail` je zpráva).

Hlavičky odpovědi

RateLimit-Policy
Platné limity ve formátu návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddělené čárkou "<name>";q=<quota>;w=<window in seconds>. key je četnost požadavků klíče API (kvóta je nárazová špička, okno je doba jejího úplného obnovení; pro relaci je to user, bez přihlašovacích údajů ip); minute, day a month jsou kvóty organizace na kalendářní minutu, den a měsíc v UTC.
RateLimit
Kolik zbývá z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit nejpřísnější položky v RateLimit-Policy (té, ve které zbývá nejméně požadavků).
X-RateLimit-Remaining
Počet požadavků, které zbývají v rámci nejpřísnějšího limitu.
X-RateLimit-Reset
Počet sekund do obnovení nejpřísnějšího limitu.

application/json

Objekt: Error

429Příliš mnoho požadavků (`api.rate_limited`), kvóta organizace na minutu, den nebo měsíc je vyčerpána (`api.quota_exceeded`; `error.details` obsahuje `quota`, `limit` a `reset_at`), organizace dosáhla svého limitu nebo je služba odpovědí vytížená (`answers.engine_busy`). Počkejte dobu uvedenou v hlavičce `Retry-After`.

Hlavičky odpovědi

Retry-After
Počet sekund, které je třeba počkat před opakováním požadavku.
RateLimit-Policy
Platné limity ve formátu návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddělené čárkou "<name>";q=<quota>;w=<window in seconds>. key je četnost požadavků klíče API (kvóta je nárazová špička, okno je doba jejího úplného obnovení; pro relaci je to user, bez přihlašovacích údajů ip); minute, day a month jsou kvóty organizace na kalendářní minutu, den a měsíc v UTC.
RateLimit
Kolik zbývá z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit nejpřísnější položky v RateLimit-Policy (té, ve které zbývá nejméně požadavků).
X-RateLimit-Remaining
Počet požadavků, které zbývají v rámci nejpřísnějšího limitu.
X-RateLimit-Reset
Počet sekund do obnovení nejpřísnějšího limitu.

application/json

Objekt: Error

Chybové kódy

Kódy, které tato operace může vrátit v error.code, kromě obecných kódů každého požadavku.

Bezpečné opakování

S každým požadavkem POST a PATCH odešlete hlavičku Idempotency-Key (například UUID). Opakování se stejným klíčem do 24 hodin vrátí uloženou odpověď, místo aby se požadavek provedl znovu.

Limity četnosti

Odpovědi obsahují hlavičky RateLimit a RateLimit-Policy a starší X-RateLimit-Limit, X-RateLimit-Remaining a X-RateLimit-Reset. Odpověď 429 má hlavičku Retry-After v sekundách: počkejte a požadavek zopakujte.

← folders · Reference API

curl -X POST 'https://api.sursa.com/v1/collections/support/folders' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"title":"Refund policy"}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Vyzkoušet

Klíč API

Klíč zůstává v paměti této karty prohlížeče a odesílá se jen na https://api.sursa.com.

Požadavky pracují se skutečnými daty vaší organizace.

Idempotency-Key header

name path *

Idempotency-Key

Když je pole prázdné, vygeneruje se pro každý požadavek nový klíč.

Tělo požadavku (JSON)