Object Fields Page
We are still updating this page
Some data may be missing — we will complete it soon.
Quick navigation: all methods
|
Fields |
Description |
Read |
Write |
|
ID |
Page identifier. Automatically created and unique within the database. |
Yes |
No |
|
CODE* |
Unique symbolic code of the page. Added to the website address if it is not the main page. |
Yes |
Yes |
|
RULE |
Regular expression for displaying the page by mask. For example, the rule |
Yes |
No |
|
ACTIVE |
Page activity: Y / N. |
Yes |
No |
|
DELETED |
Flag deleted page: Y / N. |
Yes |
Yes |
|
TITLE* |
Page title. |
Yes |
Yes |
|
XML_ID |
External key for developer needs. Not used by the service. |
Yes |
Yes |
|
DESCRIPTION |
Arbitrary description of the page. Displayed in the list of pages. |
Yes |
Yes |
|
SITE_ID* |
Identifier of the site to which the page is linked. |
Yes |
Yes |
|
CREATED_BY_ID |
Identifier of the user who created the page. |
Yes |
No |
|
MODIFIED_BY_ID |
Identifier of the user who modified the page. |
Yes |
No |
|
DATE_CREATE |
Creation date. |
Yes |
No |
|
DATE_MODIFY |
Modification date. |
Yes |
No |
|
SITEMAP |
The page is present in the sitemap ( |
Yes |
Yes |
|
FOLDER_ID |
Identifier of the folder where the page is located. |
Yes |
Yes |
|
TPL_ID |
Identifier of the view template. |
Yes |
Yes |
|
TPL_CODE |
Identifier of the partner solution template on which the site was created. For example, bitrix.eshop. |
Yes |
No |
Required parameters are marked with *
Overview of Methods
Working with Blocks
|
Method |
Description |
Version |
|
Method for adding a new block to the page. |
||
|
Method for copying a block from one page to another. |
||
|
Method for deleting a block from the page. |
||
|
Method for moving a block down one position on the page. |
||
|
Method saves an existing block on the page to "My Blocks." |
21.800.0 |
|
|
Method hides a block from the page. |
||
|
Method marks a block as deleted but does not physically remove it. |
||
|
Method restores a block from marked as deleted. |
||
|
Method for moving a block from one page to another. |
||
|
Method shows a block on the page. |
||
|
Method removes a block that was saved in "My Blocks." |
21.800.0 |
|
|
Method for moving a block up one position on the page. |
Working with Pages
|
Method |
Description |
Version |
|
Method for adding a page. |
||
|
Method for adding a page by template. |
||
|
Method copies the specified page. |
||
|
Method for deleting a page. |
||
|
Method for obtaining additional fields of the page. |
||
|
Method for obtaining a list of pages. |
||
|
Method returns the path to the page preview. |
||
|
Method returns the web address of the page. |
||
|
Method marks the page as deleted. |
||
|
Method marks the page as not deleted. |
||
|
Method moves the page to another site and/or folder. |
21.800.0 |
|
|
Method for publishing the page. |
||
|
Method removes blocks and images from the page. |
||
|
Method returns the page identifier by the provided public URL. |
21.800.0 |
|
|
Method for unpublishing the page. |
||
|
Method for modifying the page. |
Special Pages
|
Method |
Description |
|
Deletes all mentions of the page as special. |
|
|
Deletes all special pages. |
|
|
Gets the address of the special page of the site. |
|
|
Gets a list of special pages. |
|
|
Sets a special page for the site. |
Marked as deleted entities do not appear in any requests. The system does not see them. Through REST, you can only access such entities by explicitly specifying in the filter DELETED=Y.