Skip to content

page schema

A page's rows/overlays/variants/designer metadata — the top-level page.json contract.

Pull the full JSON Schema: erp schema pull page  ·  MCP: erp_get_schema {"name":"page"}

Top-level properties

PropertyTypeRequiredNotes
contractVersionyes
idstringyes
versionstringyes
publisherstringyes
title#/$defs/i18nKeyyes
templatestring
slotFillsobject
rowsarrayyes
canvasarray
overlaysarray
themeobject
route#/$defs/routeyes
menu#/$defs/menuEntry
breadcrumb#/$defs/breadcrumb
variantsarray
designer#/$defs/designeryes
accessstringone of: public, authenticated
backgroundImageUrlstring
isLoginPageboolean
isSessionExpiredPageboolean
isAccessDeniedPageboolean
devicePersistencearray
modulesarrayApp-module ids this page belongs to (e.g. "hcm-foundation-home") - TenantPageHost's per-module page listing only surfaces a page if it's present here. Load-bearing in practice for any page reached via the app sidenav/module shell, even on pages authored before this was documented.

Named sub-definitions

identifier, i18nKey, expression, breakpointOverride, breakpointOverrides, linkItem, item, column, row, routeParam, route, menuEntry, breadcrumb, overlay, variantRule, variant, canvasPosition, canvasItem, designer, devicePersistenceRule