GET /dataset/{schema_name}

Iegūstiet shēmas publicētos dokumentus — visus, vienu, kopu vai lapu — straumētus kā JSON masīvu.

Iegūstiet shēmas publicētos dokumentus — visus, vienu dokumentu, kopu pēc ID vai lapu — straumētus kā JSON masīvu. Pieejams arī adresē /schemas/{schema_name}. Attēlu atsauces tiek atrisinātas uz URL, un, ja ir iestatīts language, atbilstošais tulkojums tiek sapludināts ar pamatsaturu.

Autentifikācija: API atslēga. Atslēga ir nepieciešama tikai tad, ja serveris iestata require_schema_api_key = true; pretējā gadījumā ir atļauta anonīma lasīšana.

Ceļa parametri

Parametrs	Tips	Obligāts	Piezīmes
`schema_name`	string	jā	Dokumenta shēma, piem., `post`.

Vaicājuma parametri

Parametrs	Tips	Obligāts	Piezīmes
`websiteId`	uuid	nē	Mērķa tīmekļa vietne; pēc noklusējuma izmanto `Host` galveni / konfigurāciju.
`id`	uuid	nē	Izgūst vienu dokumentu. Pārspēj `ids`.
`ids`	string	nē	Ar komatiem atdalīti UUID (kopa, maksimums 200). Pārspēj lapošanu.
`language`	string	nē	Sapludina šīs lokalizācijas tulkojumu ar pamatsaturu.
`limit`	integer	nē	Lapas izmērs, noklusēti `200`, augšējā robeža `200`.
`offset`	integer	nē	Rindas, kuras izlaist (tiek piemērots tikai ar pozitīvu limitu).
`api_key`	string	nē	Alternatīva `x-api-key` galvenei.

Ja nav iestatīts ne id, ne ids, dokumenti tiek atgriezti kārtojumā published_at DESC.

Atbilde

Straumēts JSON masīvs. Katrs elements satur dokumenta publicēto saturu augšējā līmenī, kā arī ievietotos atslēgvārdus _id, _title un _publishedAt:

[
  {
    "_id": "...",
    "_title": "Darba sākšana",
    "_publishedAt": "2026-06-23T20:36:31Z",
    "title": "Darba sākšana",
    "description": "...",
    "content": "..."
  }
]

Satura lauki konfliktu gadījumā prevalē pār ievietotajām atslēgām. Attēlu atsaucēm formā { alt, _asset: { id } } objektā _asset tiek ievietots atrisinātais url.

Piemērs

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

Kļūdas

400 — nederīgs websiteId, nederīgs id vai nederīgs ids (tukšs, vairāk nekā 200 vai nederīgs UUID)
401 — nederīga API atslēga (vai trūkst, ja nepieciešama)
500 — vaicājuma kļūme

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

Parametrs

Tips

Obligāts

Piezīmes

schema_name

string

jā

Dokumenta shēma, piem., post.

Vaicājuma parametri

Parametrs

Tips

Obligāts

Piezīmes

websiteId

uuid

nē

Mērķa tīmekļa vietne; pēc noklusējuma izmanto Host galveni / konfigurāciju.

id

uuid

nē

Izgūst vienu dokumentu. Pārspēj ids.

ids

string

nē

Ar komatiem atdalīti UUID (kopa, maksimums 200). Pārspēj lapošanu.

language

string

nē

Sapludina šīs lokalizācijas tulkojumu ar pamatsaturu.

limit

integer

nē

Lapas izmērs, noklusēti 200, augšējā robeža 200.

offset

integer

nē

Rindas, kuras izlaist (tiek piemērots tikai ar pozitīvu limitu).

api_key

string

nē

Alternatīva x-api-key galvenei.

Ja nav iestatīts ne id, ne ids, dokumenti tiek atgriezti kārtojumā published_at DESC.

Atbilde

Straumēts JSON masīvs. Katrs elements satur dokumenta publicēto saturu augšējā līmenī, kā arī ievietotos atslēgvārdus _id, _title un _publishedAt:

[
  {
    "_id": "...",
    "_title": "Darba sākšana",
    "_publishedAt": "2026-06-23T20:36:31Z",
    "title": "Darba sākšana",
    "description": "...",
    "content": "..."
  }
]

Satura lauki konfliktu gadījumā prevalē pār ievietotajām atslēgām. Attēlu atsaucēm formā { alt, _asset: { id } } objektā _asset tiek ievietots atrisinātais url.