g
Frontend | Backend | Api

CustomEntities\Models\Api\Record

Record

Property Description Returns
name Get the name of the active revision of the record string
layout Get the layout for the record revision. Since custom entity records use a layout defined on the definition level, this returns the same layout for all records of the definition. Layout
originalPath Get the original path for the record without any custom urls applied string
fullSlug Get the slug of the record, including the slugs of parent records string
fullPath Get the full path including the custom entity index string
url Get the url or path for the record. If the record belongs to a different site, this is respected in the returned url. This method will return the url using the primary environment and the primary hostname independently of the current environment the requests is viewed through. string
id int
slug string
position int
created Date the record was created. DateTime
modified Last modification date for the record. DateTime
published DateTime
definition Definition
activeRevision RecordRevision
parent Record
children Collection (Record)
language Language
site Site
published Determines if the record is published. bool
revisions Collection (RecordRevision)
tags Tags associated with the page Collection (Tag)
categories Categories associated with the page Collection (Category)
lastRevision RecordRevision
customUrl Get the custom url used for the page. This will take precedence over the slugs of this page, parent page and the module. CustomUrl
relatedRecords Get the related records for every relationship this entity has. For relationships that allow a single record, the record or null or returned. For relationships that allow multiple records, an array is returned. RelationshipRecords
areasContent Get the areas content for the active revision AreasContent