profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Parametrinis maršrutizavimasKomponentų tipaiSetup server sent events (SSE) content refetchAdministratoriaus skydelio tarpinio serverio nustatymasSkriptų kūrimas šablonų kūrimo priemonėjeProject ScaffoldingMedia Library

Be sąsajos

Greitasis startasSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API apžvalgagetPrijunkite svetainę prie CMS APIgetGET /routesgetGauti maršrutągetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

PATCH /dataset/{schema_name}

Įterpkite arba atnaujinkite tinkinto komponento dokumento variantą, susietą su dokumento `id`.

Įkelkite arba atnaujinkite variantą (lentelės documents eilutę) tinkintame komponente, identifikuojamą pagal dokumento id. Pateikite id, kad atnaujintumėte esamą variantą; jį praleiskite, jei norite įterpti naują. Taip pat prieinama adresu /schemas/{schema_name}. Turinys tikrinamas pagal komponento schemą.

Autentifikacija: API raktas — visada privalomas, ir raktas turi turėti leidimą content_write.

Kelio parametrai

ParametrasTipasPrivalomasPastabos
schema_namestringtaipTinkinto komponento pavadinimas.

Užklausos parametrai

ParametrasTipasPrivalomasPastabos
websiteIduuidneTikslinė svetainė; jei nenurodyta, naudojama Host antraštė / konfigūracija.
api_keystringneAlternatyva antraštei x-api-key.

Užklausos turinys

{
  "id": "<uuid>",
  "title": "My variant",
  "content": { "title": "Hello", "body": "..." }
}
LaukasTipasPrivalomasPastabos
iduuidneAtnaujina atitinkantį variantą, jei pateiktas; įterpia, jei nėra arba nerastas.
titlestringneRodomas pavadinimas. Įterpiant numatytasis — "Untitled"; atnaujinant neliečiamas, jei praleistas.
contentobjecttaipLaukų reikšmės, tikrinamos pagal komponento schemą. Privalo būti JSON objektas.

Atsakymas

{
  "id": "...",
  "schema_name": "post",
  "title": "My variant",
  "status": "draft",
  "version": 2,
  "created": true
}

created reikšmė true įterpimo metu (HTTP 201), o atnaujinant — false (HTTP 200).

Pavyzdys

curl -X PATCH '{CMS_API_URL}/dataset/post?websiteId=<uuid>' \
  -H 'x-api-key: <key>' \
  -H 'Content-Type: application/json' \
  -d '{"content":{"title":"Hello"}}'

Klaidos

  • 400 — neteisingas websiteId, neobjektinis content, nežinomas arba archyvuotas komponentas arba tikrinimo klaida
  • 401 — trūksta arba neteisingas API raktas
  • 403 — raktas neturi leidimo content_write
  • 404 — pateiktas id, bet atitinkamas variantas nerastas
Continue Reading
Previous‹GET /content-changes (SSE)NextPOST /translation›