| 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 |
| showFrontendUrl | string | |
| createChildTypeLinks | array | |
| 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 |
| hateoasLinks | Get the HATEOAS links for the record | array |
| createChildUrl | Get the url for creating a child record. | string |
| showUrl | Get the url for exporting a pdf for the record. | string |
| editUrl | Get the url for editing the record. | string |
| manageUrl | Get the url for managing records. | string |
| moveUrl | Get the url for moving the record. | string |
| deleteUrl | Get the url for deleting the record. | string |
| permissionsUrl | Get the url for editing the permissions of the record. | string |
| checkPermissionsUrl | Get the url for checking user permissions for this record. | string |
| publishUrl | Get the url for publishing the record. | 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 | |
| fullPosition | Get the full position for this record. Returns a flat position if the definition of the custom entity is not positioned. | string |
| 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 |
CustomEntities\Models\Api\Record
Record