PATCH /dataset/{schema_name}

Виконайте вставку або оновлення (upsert) варіанта документа користувацького компонента, який визначається за ідентифікатором документа.

Виконайте вставку або оновлення (upsert) варіанта (рядка documents) користувацького компонента, який ідентифікується за id документа. Укажіть id, щоб оновити наявний варіант; опустіть його, щоб вставити новий. Також доступно за /schemas/{schema_name}. Вміст перевіряється згідно зі схемою компонента.

Автентифікація: ключ API — завжди обовʼязковий, і ключ має містити дозвіл content_write.

Параметри шляху

Параметр	Тип	Обовʼязково	Примітки
`schema_name`	рядок	так	Назва користувацького компонента.

Параметри запиту

Параметр	Тип	Обовʼязково	Примітки
`websiteId`	uuid	ні	Цільовий вебсайт; за замовчуванням використовується заголовок `Host` / конфігурація.
`api_key`	рядок	ні	Альтернатива до заголовка `x-api-key`.

Тіло запиту

{
  "id": "<uuid>",
  "title": "Мій варіант",
  "content": { "title": "Привіт", "body": "..." }
}

Поле	Тип	Обовʼязково	Примітки
`id`	uuid	ні	Оновлює відповідний варіант, якщо присутній; вставляє, якщо відсутній або не знайдений.
`title`	рядок	ні	Заголовок для відображення. За замовчуванням `"Untitled"` під час вставки; під час оновлення не змінюється, якщо пропущено.
`content`	обʼєкт	так	Значення полів перевіряються згідно зі схемою компонента. Має бути обʼєктом JSON.

Відповідь

{
  "id": "...",
  "schema_name": "post",
  "title": "Мій варіант",
  "status": "чернетка",
  "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":"Привіт"}}'

Помилки

400 — неправильний websiteId, content, що не є обʼєктом, невідомий або архівований компонент, або помилка валідації
401 — відсутній або недійсний ключ API
403 — ключ не має дозволу content_write
404 — передано id, але відповідний варіант не знайдено

Previous‹GET /content-changes (SSE)NextПереклад публікацій›