PUT/v1/cards-by-external-id/{external_id}

Vytvořit nebo nahradit kartu podle externího identifikátoru

upsert_card_by_external_id

Vytvoří nebo nahradí kartu podle external_id integrátora. Text odešlete jako application/json (CardTextUpsert), soubor jako multipart/form-data (CardFileUpsertForm, se stejnými kontrolami souboru jako POST /v1/cards). Pokud organizace nemá kartu s tímto external_id, karta se vytvoří v kolekci a složce z těla požadavku (201). Jinak se obsah nahradí novou verzí a znovu se zaindexuje stejně jako nová verze souboru a údaje karty (název, štítky, vlastník, kategorie, metadata) převezmou předané hodnoty (200). Nezměněný obsah novou verzi nevytvoří (status: skipped, reason: unchanged), takže opakování požadavku je bezpečné i bez Idempotency-Key. Je-li předáno metadata, nahradí celý objekt. Přístup se při vytvoření karty kontroluje jako u nahrávání a při nahrazení jako u aktualizace karty. Obsah karty, kterou volající vidí jen zčásti, se nenahrazuje (403 cards.content_whole_access). Karty zdrojů se tímto způsobem nepřepisují: pokud external_id patří dokumentu vlastního zdroje nebo nalezenou kartu spravuje zdroj, požadavek vrací 409 cards.managed_by_source. Změna obsahu odebere ověření karty, stejně jako každá nová verze (důvod update).

Autentizace

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

Parametry cesty

external_idstringpovinné
external_id karty: řetězec o délce 1–512 znaků, jedinečný v rámci organizace.
length ≥ 1, length ≤ 512

Parametry hlavičky

X-View-Asstring
Jen pro klíče API s rolí admin. Provede požadavek jako datový profil <profile>[:viewer|verifier|editor], například employee:viewer. Instalační klíč tuto hlavičku použít nemůže (403).

Parametry cookie

kb_view_asstring
Cookie režimu „View as“ pro relaci. POST /auth/view-as ji nastaví a DELETE /auth/view-as ji smaže.

Tělo požadavku

application/json

Objekt: CardTextUpsert

titlestring
length ≥ 1, length ≤ 200
bodystringpovinné
Text karty ve formátu content_type.
length ≥ 1, length ≤ 500000
content_typeCardTextContentType
collectionstring
Kolekce podle názvu při vytvoření karty. Ve výchozím nastavení výchozí kolekce instalace.
collection_idinteger | null
Kolekce podle ID při vytvoření karty. Pokud je předáno i collection, má přednost collection_id.
folder_idstring | null
Složka kolekce pro novou kartu, se stejnými kontrolami jako folder_id při nahrání souboru.
length ≤ 64
tagsarray of string | null
items ≤ 30
categorystring | null
length ≤ 60
sensitiveboolean | null
owner_idinteger | null
verify_interval_daysinteger | null
≥ 1, ≤ 3650
metadataMetadataPatch
asyncboolean
true vrátí odpověď hned a kartu zaindexuje ve frontě; false vrátí odpověď po indexování.
Výchozí: false

multipart/form-data

Objekt: CardFileUpsertForm

filestring (application/octet-stream)povinné
titlestring | null
Název karty. Pokud není předán, nová karta dostane název souboru a existující karta si ponechá svůj název.
length ≤ 200
collectionstring
collection_idinteger | null
folder_idstring | null
length ≤ 64
tagsstring
Štítky oddělené čárkami.
owner_idinteger | null
verify_interval_daysinteger | null
categorystring | null
sensitiveboolean | null
metadatastring | null
metadata: objekt JSON jako hodnota pole formuláře. Platí pravidla MetadataPatch.
asyncboolean
Výchozí: false

Odpovědi

200Karta již existovala. Její obsah byl nahrazen (`queued`, `ready`, `error`) nebo se nezměnil (`skipped`).

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: UploadResult

statusstringpovinné
Povolené hodnoty: queuedskippedreadyerror
job_idinteger
jobJob
cardCard | null
duplicatetrue
card_idstring | null
reasonstring
unchanged nebo an identical file is already indexed.
tablesinteger
timingsobject
Pole
- total_snumber
errorstring

201Karta byla vytvořena (`queued` u asynchronního požadavku, `ready` nebo `error` u synchronního).

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: UploadResult

statusstringpovinné
Povolené hodnoty: queuedskippedreadyerror
job_idinteger
jobJob
cardCard | null
duplicatetrue
card_idstring | null
reasonstring
unchanged nebo an identical file is already indexed.
tablesinteger
timingsobject
Pole
- total_snumber
errorstring

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

402Organizace dosáhla limitu tarifu (karty, úložiště nebo uživatelé). `error.details` obsahuje `kind`, `limit` a `used`.

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

413Tělo požadavku překračuje povolenou velikost.

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

415Formát souboru není podporován.

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

503Služba, na které tento požadavek závisí, je dočasně nedostupná. Zopakujte požadavek později.

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

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.

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.

← cards · Reference API

curl -X PUT 'https://api.sursa.com/v1/cards-by-external-id/EXTERNAL_ID' \
  -H "Content-Type: application/json" \
  -d '{"title":"Refund policy","body":"# Refund policy\n\nRefunds are processed within 14 days.","collection":"support"}' \
  -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.

X-View-As header

external_id path *

Tělo požadavku (JSON)