Tietoskeemat: Kategoriat

Tietoskeemat: Kategoriat. API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

Tietoskeemat

Hae — Kategoriat — Vastaus

ApiResponse_CategoryDetailData_ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

dataCategoryDetailData Pakollinen: Vastausesimerkki · CategoryDetailData.

Esimerkki: {"created_at":"2026-01-01T12:00:00Z","description":"example","id":"example","introduction":"example","is_available":true,"is_visible":false,"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","parent_id":null,"slug":"example","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Pakollinen: Vastauksen metatiedot.

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

Lisäkentät: Ei

Listaa — Kategoriat — Vastaus

ApiResponse_list_CategorySummaryData__ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

dataTaulukko <CategorySummaryData > Pakollinen: Vastausesimerkki · ApiResponse_list_CategorySummaryData__.

Esimerkki: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"is_visible":false,"name":"Example","number":"example","parent_id":null,"slug":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Pakollinen: Vastauksen metatiedot.

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

Lisäkentät: Ei

Luo — Kategoriat — Pyynnön sisältö

CategoryCreate · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

descriptionMerkkijono nullValinnainen: Kuvaus valitulla kielellä.

Merkkijono:maxLength: 50000
introductionMerkkijono nullValinnainen: Johdantoteksti valitulla kielellä.

Merkkijono:maxLength: 5000
is_visibleTotuusarvoValinnainen: Onko resurssi näkyvissä.

Oletus: false
market_idsTaulukko <Merkkijono> Valinnainen: Valittujen markkina-alueiden tunnisteet.

maxItems: 1000
Taulukko:minLength: 1maxLength: 63
meta_descriptionMerkkijono nullValinnainen: Hakukonekuvaus valitulla kielellä.

Merkkijono:maxLength: 160
meta_keywordsTaulukko <Merkkijono> nullValinnainen: Hakukoneavainsanat valitulla kielellä.

Taulukko:maxItems: 20
Taulukko / Taulukko:maxLength: 50
meta_titleMerkkijono nullValinnainen: Hakukoneotsikko valitulla kielellä.

Merkkijono:maxLength: 70
nameMerkkijonoPakollinen: Resurssin nimi kyseisessä kontekstissa.

minLength: 1maxLength: 200

Esimerkki: "Example"
parent_idMerkkijono nullValinnainen: Yläkategorian tunniste.

Merkkijono:minLength: 1maxLength: 63
slugMerkkijono nullValinnainen: URL-polun osa valitulla kielellä.

Merkkijono:maxLength: 160

Lisäkentät: Ei

Hae — Kategoriat — Vastaus

CategoryDetailData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

created_atMerkkijonoPakollinen: Luontiajankohta.

format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"
descriptionMerkkijono nullPakollinen: Kuvaus valitulla kielellä.

Esimerkki: "example"
idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. (CategoryDetailData).

Esimerkki: "example"
introductionMerkkijono nullPakollinen: Johdantoteksti valitulla kielellä.

Esimerkki: "example"
is_availableTotuusarvoPakollinen: Onko kohde saatavilla tässä kontekstissa.

Esimerkki: true
is_visibleTotuusarvoPakollinen: Onko resurssi näkyvissä.

Esimerkki: false
meta_descriptionMerkkijono nullPakollinen: Hakukonekuvaus valitulla kielellä.

Esimerkki: "example"
meta_keywordsTaulukko <Merkkijono> nullPakollinen: Hakukoneavainsanat valitulla kielellä.

Esimerkki: ["example"]
meta_titleMerkkijono nullPakollinen: Hakukoneotsikko valitulla kielellä.

Esimerkki: "example"
nameMerkkijono nullPakollinen: Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Example"
numberMerkkijonoPakollinen: Ihmiselle tarkoitettu tilaus- tai tapausnumero.

Esimerkki: "example"
parent_idMerkkijono nullPakollinen: Yläkategorian tunniste.

Esimerkki: null
slugMerkkijono nullPakollinen: URL-polun osa valitulla kielellä.

Esimerkki: "example"
updated_atMerkkijonoPakollinen: Viimeisimmän päivityksen ajankohta.

format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"
versionKokonaislukuPakollinen: Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

Listaa — Kategoriat — Vastaus

CategorySummaryData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

created_atMerkkijonoPakollinen: Luontiajankohta.

format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"
idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. (CategorySummaryData).

Esimerkki: "example"
is_availableTotuusarvoPakollinen: Onko kohde saatavilla tässä kontekstissa.

Esimerkki: true
is_visibleTotuusarvoPakollinen: Onko resurssi näkyvissä.

Esimerkki: false
nameMerkkijono nullPakollinen: Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Example"
numberMerkkijonoPakollinen: Ihmiselle tarkoitettu tilaus- tai tapausnumero.

Esimerkki: "example"
parent_idMerkkijono nullPakollinen: Yläkategorian tunniste.

Esimerkki: null
slugMerkkijono nullPakollinen: URL-polun osa valitulla kielellä.

Esimerkki: "example"
updated_atMerkkijonoPakollinen: Viimeisimmän päivityksen ajankohta.

format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"
versionKokonaislukuPakollinen: Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

Päivitä — Kategoriat — Pyynnön sisältö

CategoryUpdate · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

descriptionMerkkijono nullValinnainen: Kuvaus valitulla kielellä.

Merkkijono:maxLength: 50000
expected_versionKokonaislukuPakollinen: Ennen kirjoitusta luettu versio; ristiriita hylkää päivityksen.

minimum: 1maximum: 9223372036854775807

Esimerkki: 1
introductionMerkkijono nullValinnainen: Johdantoteksti valitulla kielellä.

Merkkijono:maxLength: 5000
is_visibleTotuusarvoValinnainen: Onko resurssi näkyvissä.
market_idsTaulukko <Merkkijono> Valinnainen: Valittujen markkina-alueiden tunnisteet.

maxItems: 1000
Taulukko:minLength: 1maxLength: 63
meta_descriptionMerkkijono nullValinnainen: Hakukonekuvaus valitulla kielellä.

Merkkijono:maxLength: 160
meta_keywordsTaulukko <Merkkijono> nullValinnainen: Hakukoneavainsanat valitulla kielellä.

Taulukko:maxItems: 20
Taulukko / Taulukko:maxLength: 50
meta_titleMerkkijono nullValinnainen: Hakukoneotsikko valitulla kielellä.

Merkkijono:maxLength: 70
nameMerkkijono nullValinnainen: Resurssin nimi kyseisessä kontekstissa.

Merkkijono:maxLength: 200

Esimerkki: "Example"
parent_idMerkkijono nullValinnainen: Yläkategorian tunniste.

Merkkijono:minLength: 1maxLength: 63
slugMerkkijono nullValinnainen: URL-polun osa valitulla kielellä.

Merkkijono:maxLength: 160

Lisäkentät: Ei