Създаване или актуализиране на вариант на документ на персонализиран компонент, идентифициран по идентификатора на документа.
Създайте или актуализирайте вариант (ред в documents) на персонализиран компонент, идентифициран по id на документа. Посочете id, за да актуализирате съществуващ вариант; пропуснете го, за да вмъкнете нов. Достъпно е също на /schemas/{schema_name}. Съдържанието се валидира спрямо схемата на компонента.
Удостоверяване: Ключ за API — винаги задължителен, и ключът трябва да има разрешението content_write.
| Параметър | Тип | Задължителен | Бележки |
|---|---|---|---|
schema_name | string | да | Името на персонализирания компонент. |
| Параметър | Тип | Задължителен | Бележки |
|---|---|---|---|
websiteId | uuid | не | Целевият уебсайт; използва стойността от заглавката Host / конфигурацията, ако липсва. |
api_key | string | не | Алтернатива на заглавката x-api-key. |
{
"id": "<uuid>",
"title": "Моят вариант",
"content": { "title": "Здравей", "body": "..." }
}
| Поле | Тип | Задължителен | Бележки |
|---|---|---|---|
id | uuid | не | Актуализира съответния вариант, когато е наличен; вмъква нов, когато липсва или не е намерен. |
title | string | не | Заглавие за показване. По подразбиране е "Untitled" при вмъкване; остава непроменено при актуализация, ако бъде пропуснато. |
content | object | да | Стойности на полетата, валидирани спрямо схемата на компонента. Трябва да бъде JSON обект. |
{
"id": "...",
"schema_name": "post",
"title": "Моят вариант",
"status": "draft",
"version": 2,
"created": true
}
created е true при вмъкване (HTTP 201) и false при актуализация (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":"Hello"}}'
400 — невалиден websiteId, content, който не е обект, неизвестен или архивиран компонент или грешка при валидирането401 — липсващ или невалиден API ключ403 — ключът няма разрешението content_write404 — id е подадено, но няма съответстващ вариант