g
Frontend | Backend | Api

Books\Models\Api\Book

Property Description Returns
parent Get the parent of the book. Will always return null. Book
unitsCount Get the number of units in this book int
pagesCount Get the number of pages in this book int
exportPdfPath Get the path of the export pdf associated with the book string
exportPdfStatus Retrieve the export status. Will return error, generate_pdfs, merging, success or null if no export has been triggered string
exportPdfDate Retrieve the date the PDF was exported. Will return the date null if no PDF exists DateTime
units Get the units of the book Collection
customFieldValues Collection (BookCustomFieldValue)
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 Get the slug of the page, including the slugs of parent pages string
fullPath Get the full path including the module route name string
originalPath Get the original path for the page without any custom urls applied string
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
lastRevision The the last revision for the page PageRevision
language The language for the page Language
children Child pages, i.e. pages located underneath this page Collection (Unit)
revisions Revisions for the page Collection (PageRevision)
tags Tags associated with the page Collection (Tag)
categories Categories associated with the page Collection (Category)
adminComments Admin comments for the page, i.e. comments that should only be displayed to backend users Collection (PageAdminComment)
published Determines if the record is published bool
owner The owner of the page, possibly having different access rights to the page User
hateoasLinks array
createChildUrl Get the url for creating a child record. string
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