GET /dataset/{schema_name}

Nouda skeemalle julkaistut asiakirjat — kaikki, yksi, erä tai sivu — suoratoistettuna JSON-taulukkona.

Nouda skeemalle julkaistut asiakirjat — kaikki, yksittäinen asiakirja, tunnisteiden mukaan haettu erä tai sivu — suoratoistettuna JSON-taulukkona. Saatavilla myös polussa /schemas/{schema_name}. Kuvaviittaukset ratkaistaan URL-osoitteiksi, ja kun language on asetettu, vastaava käännös yhdistetään perussisällön päälle.

Auth: API-avain. Avainta vaaditaan vain, jos palvelin asettaa require_schema_api_key = true; muutoin anonyymit haut ovat sallittuja.

Polkuparametrit

Parametri	Tyyppi	Pakollinen	Huomiot
`schema_name`	string	kyllä	Asiakirjan skeema, esim. `post`.

Kyselyparametrit

Parametri	Tyyppi	Pakollinen	Huomiot
`websiteId`	uuid	ei	Kohdeverkkosivusto; palautuu `Host`-otsikkoon / asetukseen.
`id`	uuid	ei	Hae yksittäinen asiakirja. Ohittaa `ids`-parametrin.
`ids`	string	ei	Pilkulla erotetut UUID-tunnukset (erä, enintään 200). Ohittaa sivutuksen.
`language`	string	ei	Yhdistä tämän aluekielen käännös perussisällön päälle.
`limit`	integer	ei	Sivun koko, oletus `200`, enimmäisarvo `200`.
`offset`	integer	ei	Ohitettavien rivien määrä (käytetään vain, kun limit on positiivinen).
`api_key`	string	ei	Vaihtoehto `x-api-key` -otsikolle.

Kun id- eikä ids-parametria ole asetettu, asiakirjat palautetaan järjestettynä published_at DESC.

Vastaus

Suoratoistettu JSON-taulukko. Jokainen alkio sisältää asiakirjan julkaistun sisällön levitettynä ylimmälle tasolle sekä lisätyt avaimet _id, _title ja _publishedAt:

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

Sisältökentät ohittavat lisätyt avaimet, jos ne törmäävät. Muodossa { alt, _asset: { id } } oleviin kuvaviittauksiin lisätään ratkaistu url _asset-kenttään.

Esimerkki

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

Virheet

400 — virheellinen websiteId, virheellinen id tai virheellinen ids (tyhjä, yli 200 tai virheellinen UUID)
401 — virheellinen API-avain (tai puuttuu, kun se vaaditaan)
500 — kyselyn epäonnistuminen

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

Parametri

Tyyppi

Pakollinen

Huomiot

schema_name

string

kyllä

Asiakirjan skeema, esim. post.

Kyselyparametrit

Parametri

Tyyppi

Pakollinen

Huomiot

websiteId

uuid

Kohdeverkkosivusto; palautuu Host-otsikkoon / asetukseen.

id

uuid

Hae yksittäinen asiakirja. Ohittaa ids-parametrin.

ids

string

Pilkulla erotetut UUID-tunnukset (erä, enintään 200). Ohittaa sivutuksen.

language

string

Yhdistä tämän aluekielen käännös perussisällön päälle.

limit

integer

Sivun koko, oletus 200, enimmäisarvo 200.

offset

integer

Ohitettavien rivien määrä (käytetään vain, kun limit on positiivinen).

api_key

string

Vaihtoehto x-api-key -otsikolle.

Kun id- eikä ids-parametria ole asetettu, asiakirjat palautetaan järjestettynä published_at DESC.

Vastaus

Suoratoistettu JSON-taulukko. Jokainen alkio sisältää asiakirjan julkaistun sisällön levitettynä ylimmälle tasolle sekä lisätyt avaimet _id, _title ja _publishedAt:

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

Sisältökentät ohittavat lisätyt avaimet, jos ne törmäävät. Muodossa { alt, _asset: { id } } oleviin kuvaviittauksiin lisätään ratkaistu url _asset-kenttään.