profound-logoProfound CMS
⌘K
Admin
Theme
DokumentaceTutorialBlogPhilosophy
DokumentaceTutorialBlogPhilosophy

Hybrid

Parametrické směrováníTypes of ComponentsSetup server sent events (SSE) content refetchNastavení proxy administračního paneluCEL Scripting in Template BuilderProject ScaffoldingKnihovna médií

Headless

Rychlý startJson a claude kódComponent Zod Pull

rozhraní REST API

REST API OverviewgetPřipojení webu k API CMSgetGET /routesgetGET /routegetGET /blocksgetzískat bloky s mezipamětí CELgetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPřeklad po publikacipatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /dataset/{schema_name}

Načtěte publikované dokumenty pro schéma — všechny, jeden, dávku nebo stránku — jako streamované pole JSON.

Načtěte publikované dokumenty pro schéma — všechny, jeden dokument, dávku podle ID nebo stránku — streamované jako pole JSON. K dispozici také na /schemas/{schema_name}. Odkazy na obrázky se převádějí na adresy URL a když je nastaveno language, odpovídající překlad se sloučí s výchozím obsahem.

Auth: API klíč. Klíč je vyžadován pouze tehdy, když server nastaví require_schema_api_key = true; jinak jsou povolena anonymní čtení.

Parametry cesty

ParametrTypPovinnéPoznámky
schema_nameřetězecanoSchéma dokumentu, např. post.

Parametry dotazu

ParametrTypPovinnéPoznámky
websiteIduuidneCílový web; pokud není zadán, použije se hlavička / konfigurace Host.
iduuidneNačte jeden dokument. Má přednost před ids.
idsřetězecneČárkami oddělená UUID (dávka, max 200). Má přednost před stránkováním.
languageřetězecneSloučí překlad pro tuto lokalitu s výchozím obsahem.
limitcelé čísloneVelikost stránky, výchozí hodnota 200, omezeno na 200.
offsetcelé číslonePočet řádků k přeskočení (použije se pouze s kladným limitem).
api_keyřetězecneAlternativa k hlavičce x-api-key.

Když nejsou nastaveny id ani ids, dokumenty se vracejí seřazené podle published_at DESC.

Odpověď

Streamované pole JSON. Každý prvek představuje publikovaný obsah dokumentu rozprostřený na nejvyšší úrovni a přidané klíče _id, _title a _publishedAt:

[
  {
    "_id": "...",
    "_title": "Začínáme",
    "_publishedAt": "2026-06-23T20:36:31Z",
    "title": "Začínáme",
    "description": "...",
    "content": "..."
  }
]

Pole obsahu mají při kolizi přednost před vloženými klíči. Odkazy na obrázky ve tvaru { alt, _asset: { id } } získají do _asset vloženou rozřešenou hodnotu url.

Příklad

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

Chyby

  • 400 — neplatné websiteId, neplatné id nebo špatné ids (prázdné, více než 200 nebo neplatné UUID)
  • 401 — neplatný API klíč (nebo chybí, pokud je vyžadován)
  • 500 — selhání dotazu
Continue Reading
Previous‹GET /components/{name}NextGET /content-changes (SSE)›