Frontend | Backend | Api

CustomEntities\Models\Api\Definition

Definition

Property Description Returns
pluralName Get the plural name for the custom entity string
pluralIdentifier Get the plural identifier for the custom entity string
recordUrlAddressable Check if an individual record can be accessed in the frontend bool
listingUrlAddressable Check if a listing of records can be accessed in the frontend bool
listingUrl Get the url for listing the records. Returns an empty string if the custom entity is not UrlAddressable, or if no listing path is defined. Otherwise, just returns the path for listing records in the current site. string
id int
name string
icon string
identifier string
path string
recordPath string
template string
sited bool
urlAddressable bool
seoSettingsEnabled bool
publishable bool
positioned bool
categorizable bool
taggable bool
parent Definition
children Collection (Definition)
layout Layout
seoSettings SeoSettings
records Collection (Record)
relationshipDefinitions Collection (RelationshipDefinition)