PATCH /dataset/{schema_name}

Infoga eller uppdatera en dokumentvariant av en anpassad komponent, med dokumentets id som nyckel.

Infoga eller uppdatera en variant (en rad i documents) av en anpassad komponent, med dokumentets id som nyckel. Ange id för att uppdatera en befintlig variant; utelämna den för att infoga en ny. Finns även på /schemas/{schema_name}. Innehållet valideras mot komponentens schema.

Autentisering: API-nyckel — alltid obligatorisk, och nyckeln måste ha behörigheten content_write.

Sökvägsparametrar

Parameter	Typ	Obligatorisk	Anmärkningar
`schema_name`	sträng	ja	Namnet på den anpassade komponenten.

Frågeparametrar

Parameter	Typ	Obligatorisk	Anmärkningar
`websiteId`	uuid	nej	Målwebbplats; faller tillbaka på headern `Host` eller konfigurationen.
`api_key`	sträng	nej	Alternativ till headern `x-api-key`.

Begärandekropp

{
  "id": "<uuid>",
  "title": "Min variant",
  "content": { "title": "Hej", "body": "..." }
}

Fält	Typ	Obligatorisk	Anmärkningar
`id`	uuid	nej	Uppdatera den matchande varianten när den finns; infoga när den saknas eller inte hittas.
`title`	sträng	nej	Visningstitel. Standardvärdet är `"Untitled"` vid infogning; lämnas oförändrad vid uppdatering om den utelämnas.
`content`	objekt	ja	Fältvärden, validerade mot komponentens schema. Måste vara ett JSON-objekt.

Svar

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

created är true vid infogning (HTTP 201) och false vid uppdatering (HTTP 200).

Exempel

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

Fel

400 — ogiltigt websiteId, content som inte är ett objekt, okänd eller arkiverad komponent eller valideringsfel
401 — saknad eller ogiltig API-nyckel
403 — nyckeln saknar behörigheten content_write
404 — id angavs men ingen matchande variant

Previous‹GET /content-changes (SSE)NextPOST /translation›