Podatkovne sheme: Strani CMS

Podatkovne sheme: Strani CMS. Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

Podatkovne sheme

Metapodatki odgovora

AnalyticsPageMeta · Shema · Podatkovne sheme: Strani CMS

paginationPagination Obvezno: Metapodatki straničenja s kazalcem.

Primer: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Obvezno: Obdobje poročanja in njegove meje.

Primer: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idNizObvezno: Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

Primer: "example"

Dodatna polja: Ne

Prikaži seznam — Strani CMS — Odgovor

ApiResponse_list_PageSummaryData__ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

dataPolje elementov <PageSummaryData > Obvezno: Primer odgovora · ApiResponse_list_PageSummaryData__.

Primer: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"market_scope":"all","number":"example","published":false,"slug":"example","title":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obvezno: Metapodatki odgovora.

Primer: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Dodatna polja: Ne

Pridobi — Strani CMS — Odgovor

ApiResponse_PageDetailData_ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

dataPageDetailData Obvezno: Primer odgovora · PageDetailData.

Primer: {"body_html":"<p>Example</p>","created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"market_scope":"all","meta_description":"example","meta_keywords":["example"],"meta_title":"example","number":"example","published":false,"slug":"example","title":"example","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obvezno: Metapodatki odgovora.

Primer: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Dodatna polja: Ne

Ustvari — Strani CMS — Telo zahteve

PageCreate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

body_htmlNiz nullIzbirno

Vsebina strani v HTML.

Niz:maxLength: 100000

market_idsPolje elementov <Niz> Izbirno

Identifikatorji izbranih trgov.

maxItems: 1000

Polje elementov:minLength: 1maxLength: 63

market_scopeNizIzbirno

Ali vir velja za vse ali izbrane trge.

Omejitve

enum: ["all", "selected"]

meta_descriptionNiz nullIzbirno

Opis za iskalnike v izbranem jeziku.

Niz:maxLength: 160

meta_keywordsPolje elementov <Niz> nullIzbirno

Ključne besede za iskalnike v izbranem jeziku.

Polje elementov:maxItems: 20

Polje elementov / Polje elementov:maxLength: 60

meta_titleNiz nullIzbirno

Naslov za iskalnike v izbranem jeziku.

Niz:maxLength: 70

publishedLogična vrednostIzbirno

Ali je vir objavljen.

Privzeto: false

slugNiz nullIzbirno

Del poti URL v izbranem jeziku.

Niz:maxLength: 160

titleNizObvezno

Naslov v izbranem jeziku.

minLength: 1maxLength: 300

Primer: "Example"

Dodatna polja: Ne

Pridobi — Strani CMS — Odgovor

PageDetailData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

body_htmlNiz nullObvezno

Vsebina strani v HTML.

Primer: "<p>Example</p>"

created_atNizObvezno

Čas nastanka.

format: "date-time"

Primer: "2026-01-01T12:00:00Z"

idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (PageDetailData).

Primer: "example"

is_availableLogična vrednostObvezno

Ali je element na voljo v tem kontekstu.

Primer: true

market_scopeNizObvezno

Ali vir velja za vse ali izbrane trge.

Omejitve

enum: ["all", "selected"]

Primer: "all"

meta_descriptionNiz nullObvezno

Opis za iskalnike v izbranem jeziku.

Primer: "example"

meta_keywordsPolje elementov <Niz> nullObvezno

Ključne besede za iskalnike v izbranem jeziku.

Primer: ["example"]

meta_titleNiz nullObvezno

Naslov za iskalnike v izbranem jeziku.

Primer: "example"

numberNizObvezno

Uporabniku prikazana številka naročila ali zahtevka.

Primer: "example"

publishedLogična vrednostObvezno

Ali je vir objavljen.

Primer: false

slugNiz nullObvezno

Del poti URL v izbranem jeziku.

Primer: "example"

titleNiz nullObvezno

Naslov v izbranem jeziku.

Primer: "example"

updated_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"

Primer: "2026-01-01T12:00:00Z"

versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1

Dodatna polja: Ne

Prikaži seznam — Strani CMS — Odgovor

PageSummaryData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

created_atNizObvezno

Čas nastanka.

format: "date-time"

Primer: "2026-01-01T12:00:00Z"

idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (PageSummaryData).

Primer: "example"

is_availableLogična vrednostObvezno

Ali je element na voljo v tem kontekstu.

Primer: true

market_scopeNizObvezno

Ali vir velja za vse ali izbrane trge.

Omejitve

enum: ["all", "selected"]

Primer: "all"

numberNizObvezno

Uporabniku prikazana številka naročila ali zahtevka.

Primer: "example"

publishedLogična vrednostObvezno

Ali je vir objavljen.

Primer: false

slugNiz nullObvezno

Del poti URL v izbranem jeziku.

Primer: "example"

titleNiz nullObvezno

Naslov v izbranem jeziku.

Primer: "example"

updated_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"

Primer: "2026-01-01T12:00:00Z"

versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1

Dodatna polja: Ne

Posodobi — Strani CMS — Telo zahteve

PageUpdate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

body_htmlNiz nullIzbirno

Vsebina strani v HTML.

Niz:maxLength: 100000

expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 1maximum: 2147483647

Primer: 1

market_idsPolje elementov <Niz> Izbirno

Identifikatorji izbranih trgov.

maxItems: 1000

Polje elementov:minLength: 1maxLength: 63

market_scopeNizIzbirno

Ali vir velja za vse ali izbrane trge.

Omejitve

enum: ["all", "selected"]

meta_descriptionNiz nullIzbirno

Opis za iskalnike v izbranem jeziku.

Niz:maxLength: 160

meta_keywordsPolje elementov <Niz> nullIzbirno

Ključne besede za iskalnike v izbranem jeziku.

Polje elementov:maxItems: 20

Polje elementov / Polje elementov:maxLength: 60

meta_titleNiz nullIzbirno

Naslov za iskalnike v izbranem jeziku.

Niz:maxLength: 70

publishedLogična vrednostIzbirno

Ali je vir objavljen.

slugNiz nullIzbirno

Del poti URL v izbranem jeziku.

Niz:maxLength: 160

titleNiz nullIzbirno

Naslov v izbranem jeziku.

Niz:maxLength: 300

Primer: "Example"

Dodatna polja: Ne