PATCH /dataset/{schema_name}

Добавляет или обновляет вариант документа пользовательского компонента, идентифицируемый по идентификатору документа.

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

Авторизация: ключ API — всегда обязателен, причём ключ должен иметь разрешение content_write.

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

Параметр	Тип	Обязателен	Примечания
`schema_name`	string	yes	Имя пользовательского компонента.

Параметры запроса

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

Тело запроса

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

Поле	Тип	Обязателен	Примечания
`id`	uuid	no	Обновляет соответствующий вариант, если указан; вставляет новый, если отсутствует или не найден.
`title`	string	no	Отображаемый заголовок. По умолчанию `"Untitled"` при вставке; при обновлении не изменяется, если пропущен.
`content`	object	yes	Значения полей, проверяемые по схеме компонента. Должен быть объектом 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":"Hello"}}'

Ошибки

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

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