GET /dataset/{schema_name}

Hämta publicerade dokument för ett schema — alla, ett, en batch eller en sida — som en strömmad JSON-array.

Hämta publicerade dokument för ett schema — alla, ett enskilt dokument, en batch efter ID:n eller en sida — strömmas som en JSON-array. Finns också på /schemas/{schema_name}. Bildreferenser löses till webbadresser, och när language är satt slås den matchande översättningen samman med basinnehållet.

Auth: API-nyckel. En nyckel krävs bara när servern ställer in require_schema_api_key = true; annars tillåts anonyma läsningar.

Sökvägsparametrar

Parameter	Typ	Obligatorisk	Kommentarer
`schema_name`	sträng	ja	Dokumentschemat, t.ex. `post`.

Frågeparametrar

Parameter	Typ	Obligatorisk	Kommentarer
`websiteId`	uuid	nej	Målsajt; faller tillbaka på `Host`-huvudet / konfigurationen.
`id`	uuid	nej	Hämta ett enda dokument. Går före `ids`.
`ids`	sträng	nej	Kommaseparerade UUID:er (batch, max 200). Går före paginering.
`language`	sträng	nej	Slår samman översättningen för denna locale med basinnehållet.
`limit`	heltal	nej	Sidstorlek, standard `200`, begränsad till `200`.
`offset`	heltal	nej	Rader att hoppa över (tillämpas bara med en positiv limit).
`api_key`	sträng	nej	Alternativ till `x-api-key`-huvudet.

När varken id eller ids är angivna returneras dokumenten sorterade efter published_at DESC.

Svar

En strömmad JSON-array. Varje element är dokumentets publicerade innehåll utspritt på toppnivå, samt de injicerade nycklarna _id, _title och _publishedAt:

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

Innehållsfält vinner över de injicerade nycklarna vid kollision. Bildreferenser av formen { alt, _asset: { id } } får en upplöst url injicerad i _asset.

Exempel

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

Fel

400 — ogiltig websiteId, ogiltig id eller felaktig ids (tom, fler än 200 eller en ogiltig UUID)
401 — ogiltig API-nyckel (eller saknas när den krävs)
500 — frågefel

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

Parameter

Typ

Obligatorisk

Kommentarer

schema_name

sträng

Dokumentschemat, t.ex. post.

Frågeparametrar

Parameter

Typ

Obligatorisk

Kommentarer

websiteId

uuid

nej

Målsajt; faller tillbaka på Host-huvudet / konfigurationen.

id

uuid

nej

Hämta ett enda dokument. Går före ids.

ids

sträng

nej

Kommaseparerade UUID:er (batch, max 200). Går före paginering.

language

sträng

nej

Slår samman översättningen för denna locale med basinnehållet.

limit

heltal

nej

Sidstorlek, standard 200, begränsad till 200.

offset

heltal

nej

Rader att hoppa över (tillämpas bara med en positiv limit).

api_key

sträng

nej

Alternativ till x-api-key-huvudet.

När varken id eller ids är angivna returneras dokumenten sorterade efter published_at DESC.

Svar

En strömmad JSON-array. Varje element är dokumentets publicerade innehåll utspritt på toppnivå, samt de injicerade nycklarna _id, _title och _publishedAt:

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

Innehållsfält vinner över de injicerade nycklarna vid kollision. Bildreferenser av formen { alt, _asset: { id } } får en upplöst url injicerad i _asset.