GET /components

Loetleb veebisaidi kohandatud komponentide (sisutiüübi skeemide) kokkuvõtted, järjestatuna nime alusel. Tagastatakse ainult kasutaja loodud kohandatud skeemid.

Autentimine: API võti (x-api-key päis või api_key päringu parameeter).

Päringu parameetrid

Vastus

JSON-massiiv komponentide kokkuvõtetest:

[
  {
    "id": "...",
    "name": "post",
    "displayName": "Post",
    "description": "A documentation Post",
    "category": "Custom",
    "tags": [],
    "fields": [],
    "icon": null,
    "source": "custom",
    "version": 8,
    "routeSlugField": "title"
  }
]

source on alati "custom". Kui displayName pole määratud, kasutatakse vaikimisi väärtust name, ning category vaikeväärtuseks on "Custom".

Näide

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

Veateated

• 400 — puudub või on vigane websiteId
• 401 — sobimatu API võti