GET /components/{name}

Извлича пълната дефиниция на полетата на един персонализиран компонент по име.

Извлича пълната дефиниция на единичен персонализиран компонент по име, включително списъка с неговите полета.

Автентикация: API ключ (заглавка x-api-key или параметър на заявката api_key).

Параметри на пътя

Параметър	Тип	Задължителен	Бележки
`name`	string	да	Името на схемата, напр. `post`.

Параметри на заявката

Параметър	Тип	Задължителен	Бележки
`websiteId`	uuid	да	Трябва да е валиден UUID.
`api_key`	string	не	Алтернатива на заглавката `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}›