Entity Preview
Resource that represents an entity preview for an entity type.
$idstring Required
$schemaconst Required
“https://schema.yext.com/config/km/entity-preview/v1" displayNameobject Required
A localized string with a default value and zero or more translations
string Required
The default value
array of object
The list of translations
Each item of this array must be:
string Required
The locale for this translation
string Required
The value of this translation
entityTypestring Required
Reference to the entity type that this preview corresponds to.
previewTypeenum (of string) Required
The type of this preview
Must be one of:
- “ROW”
- “CARD”
previewSettingsobject Required
The preview settings for this entity type
boolean Required
True to show the entity type name, false otherwise.
boolean Required
True to show the entity type symbol, false otherwise.
array Required
The list of field settings for this entity type
Each item of this array must be:
Settings for one field
The following properties are required:
- stringConfiguration
The following properties are required:
- listConfiguration
The following properties are required:
- imageConfiguration
The following properties are required:
- entityReferenceConfiguration
object Required
The identifier for the field
string Required
The ID of a field
array of string
A list of property names which define the path for the field
Each item of this array must be:
enum (of string) Required
The kind of the field
Must be one of:
- “STRING”
- “LIST”
- “IMAGE”
- “ENTITY_REFERENCE”
object
A configuration for string fields
boolean
True to emphasize the field, false otherwise. Only one field may be emphasized and if so showFieldName must be false
boolean Required
True to show the field name, false otherwise.
object
A localized string with a default value and zero or more translations
Same definition as displayNamenumber Required
An integer value between 1 and 5 that determines the max number of lines in the preview that the field’s content should take up.
object
A configuration for list fields
boolean
True to emphasize the field, false otherwise. Only one field may be emphasized and if so showFieldName must be false
boolean Required
True to show the field name, false otherwise.
object
A localized string with a default value and zero or more translations
Same definition as displayNamenumber Required
An integer value between 1 and 5 that determines the max number of lines in the preview that the field’s content should take up.
boolean Required
True to show the list value, false otherwise.
boolean Required
True to show the list count, false otherwise.
object
A configuration for image fields
boolean Required
True to show the field name, false otherwise.
object
A localized string with a default value and zero or more translations
Same definition as displayNameboolean Required
True to fit the image, false otherwise.
object
A configuration for entity reference fields
boolean
True to emphasize the field, false otherwise. Only one field may be emphasized and if so showFieldName must be false
boolean Required
True to show the field name, false otherwise.
object
A localized string with a default value and zero or more translations
Same definition as displayNamenumber Required
An integer value between 1 and 5 that determines the max number of lines in the preview that the field’s content should take up.
boolean Required
True to show the number of entities that this field references, false otherwise.
boolean Required
True to show the name of the entity that this field references, false otherwise.
boolean Required
True to show the id of the entity that this field references, false otherwise.
array of string
A list of subfields to display for a single field. This only applies to address and hours-like fields.
Each item of this array must be:
Property name of the subfield