Opdatér eller indsæt en dokumentvariant af en brugerdefineret komponent, indekseret efter dokument-id.
Opdatér eller indsæt en variant (en documents-række) af en brugerdefineret komponent, indekseret efter dokumentets id. Angiv id for at opdatere en eksisterende variant; udelad den for at indsætte en ny. Også tilgængelig på /schemas/{schema_name}. Indholdet valideres mod komponentens skema.
Autentifikation: API-nøgle — altid påkrævet, og nøglen skal have tilladelsen content_write.
| Parameter | Type | Påkrævet | Bemærkninger |
|---|---|---|---|
schema_name | string | ja | Navnet på den brugerdefinerede komponent. |
| Parameter | Type | Påkrævet | Bemærkninger |
|---|---|---|---|
websiteId | uuid | nej | Målsiden; falder tilbage på Host-headeren / konfigurationen. |
api_key | string | nej | Alternativ til x-api-key-headeren. |
{
"id": "<uuid>",
"title": "Min variant",
"content": { "title": "Hej", "body": "..." }
}
| Felt | Type | Påkrævet | Bemærkninger |
|---|---|---|---|
id | uuid | nej | Opdater den matchende variant, når den er til stede; indsæt, når den mangler eller ikke findes. |
title | string | nej | Visningstitel. Standard er "Untitled" ved indsættelse; forbliver uændret ved opdatering, når den udelades. |
content | object | ja | Feltværdier, valideret mod komponentens skema. Skal være et JSON-objekt. |
{
"id": "...",
"schema_name": "post",
"title": "Min variant",
"status": "kladde",
"version": 2,
"created": true
}
created er true ved indsættelse (HTTP 201) og false ved opdatering (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":"Hej"}}'
400 — ugyldig websiteId, content der ikke er et objekt, ukendt eller arkiveret komponent, eller valideringsfejl401 — manglende eller ugyldig API-nøgle403 — nøglen mangler tilladelsen content_write404 — id angivet, men ingen matchende variant