GET /dataset/{schema_name}

Gaukite paskelbtus schemos dokumentus — visus, vieną, paketą arba puslapį — kaip srautu teikiamą JSON masyvą.

Gaukite paskelbtus schemos dokumentus — visus, vieną dokumentą, paketą pagal ID arba puslapį — tiekiamus srautu kaip JSON masyvą. Taip pat pasiekiama adresu /schemas/{schema_name}. Atvaizdų nuorodos išsprendžiamos į URL, o nustačius language atitinkamas vertimas sujungiamas su bazine turinio versija.

Autentifikavimas: API raktas. Raktas reikalingas tik tada, kai serveris nustato require_schema_api_key = true; kitu atveju leidžiami anoniminiai nuskaitymai.

Kelio parametrai

Parametras	Tipas	Privalomas	Pastabos
`schema_name`	string	taip	Dokumento schema, pvz., `post`.

Užklausos parametrai

Parametras	Tipas	Privalomas	Pastabos
`websiteId`	uuid	ne	Tikslinė svetainė; jeigu nenurodoma, naudojama `Host` antraštė / konfigūracija.
`id`	uuid	ne	Gauti vieną dokumentą. Turi prioritetą prieš `ids`.
`ids`	string	ne	Kableliais atskirti UUID (paketas, daugiausia 200). Turi prioritetą prieš puslapiavimą.
`language`	string	ne	Sujungia šios lokalės vertimą su bazine turinio versija.
`limit`	integer	ne	Puslapio dydis, numatytoji reikšmė `200`, maksimali `200`.
`offset`	integer	ne	Praleidžiamų eilučių skaičius (taikoma tik kai `limit` teigiamas).
`api_key`	string	ne	Alternatyva `x-api-key` antraštei.

Kai nenustatyti nei id, nei ids, dokumentai grąžinami išrikiuoti pagal published_at DESC.

Atsakymas

Transliuojamas JSON masyvas. Kiekviename elemente pateikiamas paskelbtas dokumento turinys aukščiausiame lygyje ir pridėti raktai _id, _title ir _publishedAt:

[
  {
    "_id": "...",
    "_title": "Darbo pradžia",
    "_publishedAt": "2026-06-23T20:36:31Z",
    "title": "Darbo pradžia",
    "description": "...",
    "content": "..."
  }
]

Turinio laukai turi prioritetą prieš įterptus raktus, jei įvyksta konfliktas. Atvaizdų nuorodoms, kurios turi formą { alt, _asset: { id } }, į _asset įterpiamas išspręstas url.

Pavyzdys

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

Klaidos

400 — neteisingas websiteId, neteisingas id arba blogi ids (tušti, daugiau nei 200 arba neteisingas UUID)
401 — neteisingas API raktas (arba jo nėra, kai būtinas)
500 — užklausos klaida

Previous‹GET /components/{name}NextGET /content-changes (SSE)›

Parametras

Tipas

Privalomas

Pastabos

schema_name

string

taip

Dokumento schema, pvz., post.

Užklausos parametrai

Parametras

Tipas

Privalomas

Pastabos

websiteId

uuid

Tikslinė svetainė; jeigu nenurodoma, naudojama Host antraštė / konfigūracija.

id

uuid

Gauti vieną dokumentą. Turi prioritetą prieš ids.

ids

string

Kableliais atskirti UUID (paketas, daugiausia 200). Turi prioritetą prieš puslapiavimą.

language

string

Sujungia šios lokalės vertimą su bazine turinio versija.

limit

integer

Puslapio dydis, numatytoji reikšmė 200, maksimali 200.

offset

integer

Praleidžiamų eilučių skaičius (taikoma tik kai limit teigiamas).

api_key

string

Alternatyva x-api-key antraštei.

Kai nenustatyti nei id, nei ids, dokumentai grąžinami išrikiuoti pagal published_at DESC.

Atsakymas

Transliuojamas JSON masyvas. Kiekviename elemente pateikiamas paskelbtas dokumento turinys aukščiausiame lygyje ir pridėti raktai _id, _title ir _publishedAt:

[
  {
    "_id": "...",
    "_title": "Darbo pradžia",
    "_publishedAt": "2026-06-23T20:36:31Z",
    "title": "Darbo pradžia",
    "description": "...",
    "content": "..."
  }
]

Turinio laukai turi prioritetą prieš įterptus raktus, jei įvyksta konfliktas. Atvaizdų nuorodoms, kurios turi formą { alt, _asset: { id } }, į _asset įterpiamas išspręstas url.