GET /components/{name}

Nouda yhden mukautetun komponentin koko kenttämääritelmä nimen perusteella.

Nouda yhden mukautetun komponentin koko määritelmä nimen perusteella, mukaan lukien sen kenttäluettelo.

Todennus: API-avain (x-api-key-otsake tai api_key-kyselyparametri).

Polkuparametrit

Parametri	Tyyppi	Pakollinen	Huomautukset
`name`	merkkijono	kyllä	Skeeman nimi, esim. `post`.

Kyselyparametrit

Parametri	Tyyppi	Pakollinen	Huomautukset
`websiteId`	uuid	kyllä	Täytyy olla kelvollinen UUID.
`api_key`	merkkijono	ei	Vaihtoehto `x-api-key`-otsakkeelle.

Vastaus

{
  "id": "...",
  "name": "postaus",
  "displayName": "Postaus",
  "description": "Dokumentaatiopostaus",
  "category": "Mukautettu",
  "titleField": "otsikko",
  "routeSlugField": "otsikko",
  "icon": null,
  "fields": [
    { "name": "otsikko", "type": "merkkijono", "required": true }
  ],
  "slugFields": ["otsikko", "kuvaus"],
  "version": 8
}

slugFields lasketaan — kaikkien merkkijonotyyppisten kenttien nimet.

Esimerkki

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

Virheet

400 — puuttuva tai virheellinen websiteId
401 — virheellinen API-avain
404 — skeemaa ei löydy

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