GET /components/{name}

Отримайте повне визначення полів одного нестандартного компонента за назвою.

Отримайте повне визначення одного нестандартного компонента за назвою, включно зі списком його полів.

Авторизація: Ключ API (заголовок x-api-key або параметр запиту api_key).

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

Параметр	Тип	Обов'язковий	Примітки
`name`	рядок	так	Назва схеми, наприклад `post`.

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

Параметр	Тип	Обов'язковий	Примітки
`websiteId`	uuid	так	Повинен бути дійсним UUID.
`api_key`	рядок	ні	Альтернатива заголовку `x-api-key`.

Відповідь

{
  "id": "...",
  "name": "post",
  "displayName": "Post",
  "description": "A documentation Post",
  "category": "Custom",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

slugFields обчислюється — це назви всіх полів типу «рядок».

Приклад

curl '{CMS_API_URL}/components/post?websiteId=<uuid>' \
  -H 'x-api-key: <key>'

Помилки

400 — відсутній або некоректний websiteId
401 — недійсний ключ API
404 — схему не знайдено

Previous‹GET /components NextGET /dataset/{schema_name}›