Field Presentation
Resource that represents a field presentation for an entity type.
$idstring Required
$schemaconst Required
“https://schema.yext.com/config/km/field-presentation/v1" entityTypestring Required
Reference to the entity type that this field presentation belongs to.
displayNamestring Required
Display name of this field presentation.
displayNameTranslationsarray
Translations of this field presentation’s display name.
Each item of this array must be:
A pair of locale code and the translation for this locale
string Required
The locale code of the translation.
string Required
The value of the translation.
presentationEntriesarray
The list of presentation entries.
Each item of this array must be:
A field section.
const Required
The type of this presentation entry.
Specific value:“SECTION” array
List of field entries.
Each item of this array must be:
A field section entry
string Required
The ID of a field
boolean
Flag that determines if this field is visible on the Entity Add UI
string Required
Display name of the field section.
array
Translations of the display name for different locale codes.
Each item of this array must be:
A pair of locale code and the translation for this locale
Same definition as displayNameTranslations_itemsboolean
A boolean to determine if the section is collapsed when the user first enters the page.
A field section divider.
const Required
The type of this presentation entry.
Specific value:“DIVIDER” string Required
Display name of the field section divider.
array
Translations of the display name for different locale codes.
Each item of this array must be:
A pair of locale code and the translation for this locale
Same definition as displayNameTranslations_items