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": "Документационный пост",
  "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‹Получить компоненты NextGET /dataset/{schema_name}›