Frontend | Backend | Api

Documentation\Models\Api\Page

Documentation page. Can have multiple revisions and has one active revision.

Property Description Returns
name Get the name for the active revision string
text Get the text for the active revision string
parents Get the parents of this page, with this page being the last element in the array array
fullSlug string
fullPath string
originalPath string
global Return the info that this is NOT a global documentation page bool
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 int
position int
slug string
created Get the date the record was created. DateTime
modified Get the last modification date for the record. DateTime
published Get the date the record was published or is scheduled to be published. DateTime
activeRevision PageRevision
parent Page
children Collection (Page)
owner User
published Check if the record is published. bool
revisions Collection (PageRevision)
lastRevision Get the last revision for the entity. If a revision has been added, this will be the newly added revision. PageRevision
comments Collection (Comment)
fullPosition Get the full, dot-separated full position for hierarchical records string