Voeg een documentvariant van een aangepaste component in of werk deze bij, met de document-id als sleutel.
Voeg een variant (een documents-rij) van een aangepaste component in of werk deze bij, met de document-id als sleutel. Geef id op om een bestaande variant bij te werken; laat dit weg om een nieuwe variant toe te voegen. Ook beschikbaar op /schemas/{schema_name}. De inhoud wordt gevalideerd aan de hand van het schema van de component.
Authenticatie: API-sleutel — altijd vereist, en de sleutel moet de machtiging content_write hebben.
| Parameter | Type | Vereist | Notities |
|---|---|---|---|
schema_name | string | ja | De naam van de aangepaste component. |
| Parameter | Type | Vereist | Notities |
|---|---|---|---|
websiteId | uuid | nee | Doelwebsite; valt terug op de Host-header/configuratie. |
api_key | string | nee | Alternatief voor de header x-api-key. |
{
"id": "<uuid>",
"title": "Mijn variant",
"content": { "title": "Hallo", "body": "..." }
}
| Veld | Type | Vereist | Notities |
|---|---|---|---|
id | uuid | nee | Werk de overeenkomende variant bij wanneer aanwezig; voeg er een toe wanneer deze ontbreekt of niet wordt gevonden. |
title | string | nee | Weergavetitel. Standaard "Untitled" bij invoegen; blijft ongewijzigd bij bijwerken wanneer weggelaten. |
content | object | ja | Veldwaarden, gevalideerd aan de hand van het schema van de component. Moet een JSON-object zijn. |
{
"id": "...",
"schema_name": "post",
"title": "Mijn variant",
"status": "concept",
"version": 2,
"created": true
}
created is true bij invoegen (HTTP 201) en false bij bijwerken (HTTP 200).
curl -X PATCH '{CMS_API_URL}/dataset/post?websiteId=<uuid>' \
-H 'x-api-key: <key>' \
-H 'Content-Type: application/json' \
-d '{"content":{"title":"Hallo"}}'
400 — ongeldige websiteId, niet-object content, onbekende of gearchiveerde component, of validatiefout401 — ontbrekende of ongeldige API-sleutel403 — sleutel mist de machtiging content_write404 — id opgegeven maar geen overeenkomende variant