PATCH /dataset/{schema_name}

Vstavi ali posodobi različico dokumenta prilagojene komponente, ki je ključena z ID-jem dokumenta.

Vstavite ali posodobite (upsert) različico (vrstico documents) prilagojene komponente, ki je ključena z id dokumenta. id navedite, da posodobite obstoječo različico; izpustite ga, da vstavite novo. Na voljo tudi na /schemas/{schema_name}. Vsebina se preveri glede na shemo komponente.

Preverjanje pristnosti: Ključ API — vedno obvezen, ključ mora imeti dovoljenje content_write.

Parametri poti

Parameter	Vrsta	Zahtevano	Opombe
`schema_name`	niz	da	Ime prilagojene komponente.

Parametri poizvedbe

Parameter	Vrsta	Zahtevano	Opombe
`websiteId`	uuid	ne	Ciljno spletno mesto; privzeto se uporabi glava oziroma konfiguracija `Host`.
`api_key`	niz	ne	Alternativa glavi `x-api-key`.

Telo zahteve

{
  "id": "<uuid>",
  "title": "Moja različica",
  "content": { "title": "Pozdrav", "body": "..." }
}

Polje	Vrsta	Zahtevano	Opombe
`id`	uuid	ne	Posodobi ujemajočo se različico, kadar je prisotna; vstavi, kadar je odsotna ali je ni mogoče najti.
`title`	niz	ne	Prikazani naslov. Ob vstavitvi je privzeta vrednost `"Untitled"`; pri posodobitvi ostane nespremenjen, če je izpuščen.
`content`	objekt	da	Vrednosti polj, preverjene glede na shemo komponente. Mora biti objekt JSON.

Odziv

{
  "id": "...",
  "schema_name": "objava",
  "title": "Moja različica",
  "status": "osnutek",
  "version": 2,
  "created": true
}

created je true pri vstavitvi (HTTP 201) in false pri posodobitvi (HTTP 200).

Primer

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

Napake

400 — neveljaven websiteId, content, ki ni objekt, neznana ali arhivirana komponenta ali napaka pri preverjanju veljavnosti
401 — manjkajoč ali neveljaven ključ API
403 — ključu manjka dovoljenje content_write
404 — id je podan, vendar ni ustrezne različice

Previous‹GET /content-changes (SSE)NextPrevajanje objave›