Frontend | Backend | Api

Books\Models\Api\Page

Property Description Returns
parent Get the unit for the page Unit
positionInBook Get the position of the page in the whole book => the page number Returns null if no book is set for the page int
unit Get the unit for this page Unit
customFieldValues Collection (PageCustomFieldValue)
customFieldContent Get a serialized representation of the custom fields associated with the record object
customFields Get the custom fields for this entity array
name Get the name for the active revision string
fullSlug Gets the slug including the slugs of parent entities. If there is a custom URL, it is returned instead. string
fullPath Gets the full path including the module route name. If there is a custom URL, it is returned instead. string
originalPath Gets the original path for the entity without any custom URL applied string
assignedWorkflow Get the workflow assigned to the record or entity Workflow
assignedWorkflow Check whether the record has an assigned workflow bool
branches Get the branches associated with the record Collection
numRevisionsWithoutBranch Get the number of revisions without branch int
revisionsWithoutBranch Get all revisions without branch Collection
id The ID of the page int
slug The slug for the page, i.e. the url portion identifying the page. Does not include parent slugs or the module slug. string
publishAt Date at which the page will be published or has been published DateTime
unpublishAt Date after which the page should not be shown anymore DateTime
position Position of the page in the list of pages at the same level (i.e. with the same parent) int
created Date at which the page was created DateTime
modified Date at which the page was last modified DateTime
published Date at which the page was published DateTime
site Site associated with the page Site
activeRevision The active revision for the page PageRevision
revisions Revisions for the page Collection (PageRevision)
lastRevision Get the last revision for the entity. If a revision has been added, this will be the newly added revision. PageRevision
tags Tags associated with the page Collection (Tag)
categories Categories associated with the page Collection (Category)
published Determines if the record is published. bool
owner The owner of the page, possibly having different access rights to the page. User
language The language for the page Language
seoSettings The SEO settings for the page, like title, descriptions, robots and keywords SeoSettings
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
fullPosition Get the full, dot-separated full position for hierarchical records string
hateoasLinks Get the HATEOAS links for the record array
editUrl Get the url for editing the record. string
moveUrl Get the url for moving the record. string
deleteUrl Get the url for deleting the record. string
publishUrl Get the url for publishing the record. string
areasContent Get the areas content for the active revision AreasContent