PATCH/v1/folders/{folder_id}

Mappa átnevezése, áthelyezése vagy átrendezése

update_folder

A mappán, áthelyezésnél pedig az új helyen is (a szülőmappán, illetve gyökér esetén a gyűjteményen) COLLECTION_EDIT_CARDS jogosultság szükséges. A parent_id: null a gyűjtemény gyökerébe helyezi át a mappát. A prev_sibling_id az új (vagy a jelenlegi) szülő testvérelemei közötti helyet adja meg: first, last vagy egy testvérelem azonosítója. Ha egy mappát a saját almappájába helyezel át, a válasz folders.cycle, háromszintűnél mélyebb részfa esetén pedig folders.depth_exceeded. A color és az icon a megjelenést állítja be, a null pedig automatikusra állítja vissza; a megengedett listán kívüli érték esetén a válasz folders.appearance_invalid.

Hitelesítés

Küldj egy API-kulcsot az Authorization fejlécben: Authorization: Bearer <kulcs>.

Útvonal-paraméterek

folder_idstringkötelező

Fejlécparaméterek

Idempotency-Keystring
Kulcs egy írási kérés biztonságos megismétléséhez: 1–255 nyomtatható ASCII-karakter; logikai műveletenként egy UUID v4 ajánlott. Ha 24 órán belül ugyanazzal a kulccsal ismétled meg a kérést, a művelet nem fut le újra: a mentett választ kapod vissza (állapot, fejlécek és törzs) az Idempotency-Replayed: true fejléccel. Ugyanaz a kulcs más metódussal, útvonallal, Content-Type értékkel vagy törzzsel 409 api.idempotency_mismatch választ ad; amíg az első kérés még fut, a válasz 409 api.idempotency_in_progress, Retry-After: 1 fejléccel. 5xx vagy 429 válasz után a kulcs felszabadul, és a megismételt kérés újra lefuttatja a műveletet. A kulcs a szervezethez és a hívóhoz (API-kulcs, felhasználó vagy egyéni forrás forráskulcsa) kötődik.
length ≥ 1, length ≤ 255

Kéréstörzs

application/json

Objektum: FolderUpdate

titlestring
length ≥ 1, length ≤ 200
parent_idstring | null
Új szülőmappa. A null a gyűjtemény gyökerébe helyezi a mappát. Ha a mező hiányzik, a szülőmappa nem változik.
prev_sibling_idFolderPosition
colorFolderColor | null
A mappa színe a palettáról. A null visszaállítja automatikusra; ha a mező hiányzik, a szín nem változik.
iconFolderIcon | null
A mappa ikonja. A null visszaállítja automatikusra; ha a mező hiányzik, az ikon nem változik.
metadataMetadataPatch

Válaszok

200Sikeres válasz

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.
Idempotency-Replayed
A true azt jelenti, hogy a válasz az ehhez az Idempotency-Key kulcshoz mentett válasz megismétlése: a művelet nem futott le újra.

application/json

Objektum: Folder

idstringkötelező
collection_idintegerkötelező
parent_idstring | nullkötelező
titlestringkötelező
sort_keystringkötelező
created_byinteger | nullkötelező
created_atstring (date-time)kötelező
updated_atstring (date-time)kötelező
colorFolderColor | nullkötelező
A mappa színe a palettáról, minden felhasználónak ugyanaz. A null automatikus színt jelent: a kliens a név alapján választ színt a palettáról.
iconFolderIcon | nullkötelező
A mappa ikonja, minden felhasználónak ugyanaz. A null automatikus ikont jelent a facsomópont top_category mezője alapján.
permissionsarray of stringkötelező
metadataMetadata

400A kérés érvénytelen: egy paraméter értéke vagy az objektum állapota nem teszi lehetővé a műveletet (a `detail` egy üzenet).

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: Error

401Nem érkeztek hitelesítő adatok (sem munkamenet-süti, sem API-kulcs), vagy a kulcs nem található.

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: Error

403A művelet nem engedélyezett: a szerepkör nem elegendő, nincs hozzáférés a gyűjteményhez vagy a kártyához, a kérés „View as” módban fut, vagy a szervezetet felfüggesztették vagy törölték (a `detail` egy objektum, `code: org_suspended | org_deleted` mezővel).

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: Error

404Az objektum nem létezik, vagy nem érhető el számodra. Az API nem erősíti meg, hogy egy korlátozott hozzáférésű objektum létezik.

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: Error

409Az objektum állapota nem teszi lehetővé a műveletet, például ismétlődés, folyamatban lévő indexelés vagy már feldolgozott feladat miatt.

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: Error

422Érvényesítési hiba: a törzs vagy a paraméterek nem felelnek meg a sémának (a `detail` az érvényesítési hibák listája), vagy egy paraméter értéke kívül esik a megengedett tartományon (a `detail` egy üzenet).

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: Error

429Túl sok kérés (`api.rate_limited`), elfogyott a szervezet percre, napra vagy hónapra szóló kvótája (`api.quota_exceeded`; az `error.details` a `quota`, a `limit` és a `reset_at` mezőt tartalmazza), a szervezet elérte a korlátját, vagy a válaszszolgáltatás foglalt (`answers.engine_busy`). Várj a `Retry-After` fejlécben megadott ideig.

Válaszfejlécek

Retry-After
Ennyi másodpercet várj, mielőtt újrapróbálod a kérést.
RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: Error

Hibakódok

Azok a kódok, amelyeket ez a végpont hiba esetén az error.code mezőben visszaadhat, a minden kérésre érvényes általános kódokon kívül.

Biztonságos újrapróbálkozás

Minden POST és PATCH kéréssel küldj Idempotency-Key fejlécet (például egy UUID-t). Ha 24 órán belül ugyanazzal a kulccsal megismétled a kérést, a mentett választ kapod vissza, és a kérés nem fut le újra.

Gyakorisági korlátok

A válaszokban ott van a RateLimit és a RateLimit-Policy fejléc, valamint a korábbi X-RateLimit-Limit, X-RateLimit-Remaining és X-RateLimit-Reset fejléc. A 429-es válasz Retry-After fejléce másodpercben adja meg a várakozást: várj, majd próbáld újra.

← folders · API-referencia

curl -X PATCH 'https://api.sursa.com/v1/folders/FOLDER_ID' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"title":"Refund policy","parent_id":"string","prev_sibling_id":"string"}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Kipróbálás

API-kulcs

A kulcs ennek a lapnak a memóriájában marad, és a konzol csak ide küldi el: https://api.sursa.com.

A kérések a szervezeted valódi adataival dolgoznak.

Idempotency-Key header

folder_id path *

Idempotency-Key

Ha a mező üres, minden kéréshez új kulcs készül.

Kéréstörzs (JSON)