Schémas de données: Pages CMS

Schémas de données: Pages CMS. Champs, types et contraintes des données acceptées ou renvoyées par l’API.

Schémas de données

Métadonnées de la réponse

AnalyticsPageMeta · Schéma · Schémas de données: Pages CMS

paginationPagination Obligatoire: Métadonnées de pagination par curseur.

Exemple: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Obligatoire: Période du rapport et ses bornes.

Exemple: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idChaîneObligatoire: Identifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.

minLength: 1maxLength: 100

Exemple: "example"

Champs supplémentaires: Non

Lister — Pages CMS — Réponse

ApiResponse_list_PageSummaryData__ · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

dataTableau <PageSummaryData > Obligatoire: Exemple de réponse · ApiResponse_list_PageSummaryData__.

Exemple: [{"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 Obligatoire: Métadonnées de la réponse.

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

Champs supplémentaires: Non

Obtenir — Pages CMS — Réponse

ApiResponse_PageDetailData_ · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

dataPageDetailData Obligatoire: Exemple de réponse · PageDetailData.

Exemple: {"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 Obligatoire: Métadonnées de la réponse.

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

Champs supplémentaires: Non

Créer — Pages CMS — Corps de la requête

PageCreate · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

body_htmlChaîne nullFacultatif

Contenu de la page au format HTML.

Chaîne:maxLength: 100000

market_idsTableau <Chaîne> Facultatif

Identifiants des marchés sélectionnés.

maxItems: 1000

Tableau:minLength: 1maxLength: 63

market_scopeChaîneFacultatif

Indique si la ressource concerne tous les marchés ou une sélection.

Contraintes

enum: ["all", "selected"]

meta_descriptionChaîne nullFacultatif

Description pour les moteurs de recherche dans la langue sélectionnée.

Chaîne:maxLength: 160

meta_keywordsTableau <Chaîne> nullFacultatif

Mots-clés pour les moteurs de recherche dans la langue sélectionnée.

Tableau:maxItems: 20

Tableau / Tableau:maxLength: 60

meta_titleChaîne nullFacultatif

Titre pour les moteurs de recherche dans la langue sélectionnée.

Chaîne:maxLength: 70

publishedBooléenFacultatif

Indique si la ressource est publiée.

Valeur par défaut: false

slugChaîne nullFacultatif

Segment du chemin URL dans la langue sélectionnée.

Chaîne:maxLength: 160

titleChaîneObligatoire

Titre dans la langue sélectionnée.

minLength: 1maxLength: 300

Exemple: "Example"

Champs supplémentaires: Non

Obtenir — Pages CMS — Réponse

PageDetailData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

body_htmlChaîne nullObligatoire

Contenu de la page au format HTML.

Exemple: "<p>Example</p>"

created_atChaîneObligatoire

Date et heure de création.

format: "date-time"

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

idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée. (PageDetailData).

Exemple: "example"

is_availableBooléenObligatoire

Indique si l'article est disponible dans ce contexte.

Exemple: true

market_scopeChaîneObligatoire

Indique si la ressource concerne tous les marchés ou une sélection.

Contraintes

enum: ["all", "selected"]

Exemple: "all"

meta_descriptionChaîne nullObligatoire

Description pour les moteurs de recherche dans la langue sélectionnée.

Exemple: "example"

meta_keywordsTableau <Chaîne> nullObligatoire

Mots-clés pour les moteurs de recherche dans la langue sélectionnée.

Exemple: ["example"]

meta_titleChaîne nullObligatoire

Titre pour les moteurs de recherche dans la langue sélectionnée.

Exemple: "example"

numberChaîneObligatoire

Numéro de commande ou de demande visible par l'utilisateur.

Exemple: "example"

publishedBooléenObligatoire

Indique si la ressource est publiée.

Exemple: false

slugChaîne nullObligatoire

Segment du chemin URL dans la langue sélectionnée.

Exemple: "example"

titleChaîne nullObligatoire

Titre dans la langue sélectionnée.

Exemple: "example"

updated_atChaîneObligatoire

Date et heure de la dernière modification.

format: "date-time"

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

versionEntierObligatoire

Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 1

Champs supplémentaires: Non

Lister — Pages CMS — Réponse

PageSummaryData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

created_atChaîneObligatoire

Date et heure de création.

format: "date-time"

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

idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée. (PageSummaryData).

Exemple: "example"

is_availableBooléenObligatoire

Indique si l'article est disponible dans ce contexte.

Exemple: true

market_scopeChaîneObligatoire

Indique si la ressource concerne tous les marchés ou une sélection.

Contraintes

enum: ["all", "selected"]

Exemple: "all"

numberChaîneObligatoire

Numéro de commande ou de demande visible par l'utilisateur.

Exemple: "example"

publishedBooléenObligatoire

Indique si la ressource est publiée.

Exemple: false

slugChaîne nullObligatoire

Segment du chemin URL dans la langue sélectionnée.

Exemple: "example"

titleChaîne nullObligatoire

Titre dans la langue sélectionnée.

Exemple: "example"

updated_atChaîneObligatoire

Date et heure de la dernière modification.

format: "date-time"

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

versionEntierObligatoire

Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 1

Champs supplémentaires: Non

Modifier — Pages CMS — Corps de la requête

PageUpdate · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

body_htmlChaîne nullFacultatif

Contenu de la page au format HTML.

Chaîne:maxLength: 100000

expected_versionEntierObligatoire

Version lue avant l'écriture ; une différence entraîne le rejet de la modification.

minimum: 1maximum: 2147483647

Exemple: 1

market_idsTableau <Chaîne> Facultatif

Identifiants des marchés sélectionnés.

maxItems: 1000

Tableau:minLength: 1maxLength: 63

market_scopeChaîneFacultatif

Indique si la ressource concerne tous les marchés ou une sélection.

Contraintes

enum: ["all", "selected"]

meta_descriptionChaîne nullFacultatif

Description pour les moteurs de recherche dans la langue sélectionnée.

Chaîne:maxLength: 160

meta_keywordsTableau <Chaîne> nullFacultatif

Mots-clés pour les moteurs de recherche dans la langue sélectionnée.

Tableau:maxItems: 20

Tableau / Tableau:maxLength: 60

meta_titleChaîne nullFacultatif

Titre pour les moteurs de recherche dans la langue sélectionnée.

Chaîne:maxLength: 70

publishedBooléenFacultatif

Indique si la ressource est publiée.

slugChaîne nullFacultatif

Segment du chemin URL dans la langue sélectionnée.

Chaîne:maxLength: 160

titleChaîne nullFacultatif

Titre dans la langue sélectionnée.

Chaîne:maxLength: 300

Exemple: "Example"

Champs supplémentaires: Non