Поля шаблона представления

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Поля шаблона представления описывают структуру, по которой Битрикс24 собирает страницу сайта: расположение основного контента и дополнительных областей. Метод landing.template.getlist возвращает эти поля для шаблонов текущего Битрикс24.

Scope: landing

Кто может получить поля: пользователь с правом доступа к разделу «Сайты и магазины»

Как получить поля шаблона

Передайте названия нужных полей в params.select метода landing.template.getlist. Например, чтобы узнать внешний код шаблона и число его дополнительных областей, а также получить разметку с их макросами:

{
    "params": {
        "select": ["ID", "XML_ID", "AREA_COUNT", "CONTENT"]
    }
}

Если select не передан, метод возвращает все доступные поля. Для выборки, фильтрации, сортировки и группировки доступны поля из таблицы ниже. Поля с точкой в select и filter, например CREATED_BY.NAME, не поддерживаются.

Поля шаблона представления

Поле
тип

Описание

ID
integer

Идентификатор шаблона представления

ACTIVE
string

Активность шаблона представления

Возможные значения:
Y — шаблон активен
N — шаблон неактивен

По умолчанию — Y

AREA_COUNT
integer

Количество дополнительных областей шаблона, кроме основной области #CONTENT#. Дополнительные области обозначаются в CONTENT макросами #AREA_1#, #AREA_2# и далее

SORT
integer

Порядок сортировки шаблона

TITLE
string

Название шаблона. Для системных шаблонов значение может быть локализовано для текущего языка портала

XML_ID
string

Внешний код шаблона. Его удобно использовать, чтобы сопоставлять шаблоны в интеграции и не завязываться на внутренний ID

CONTENT
string

HTML-разметка шаблона с макросами областей, например #CONTENT#, #AREA_1#, #AREA_2#

CREATED_BY_ID
integer

Идентификатор пользователя, который создал шаблон

MODIFIED_BY_ID
integer

Идентификатор пользователя, который последним изменил шаблон

DATE_CREATE
datetime

Дата и время создания шаблона. В ответе REST возвращается строкой. Формат зависит от региональных настроек портала, например 04/20/2020 12:48:10 pm

DATE_MODIFY
datetime

Дата и время последнего изменения шаблона. В ответе REST возвращается строкой. Формат зависит от региональных настроек портала, например 04/20/2020 12:48:10 pm

Как связаны CONTENT и AREA_COUNT

В CONTENT макрос #CONTENT# обозначает основную область страницы. Макросы #AREA_1#, #AREA_2# и далее обозначают дополнительные области, к которым можно привязать отдельные страницы. Их количество указано в AREA_COUNT.

Например, фрагмент разметки шаблона с одной дополнительной областью может выглядеть так:

<main>#CONTENT#</main>
<aside>#AREA_1#</aside>

В этом примере AREA_COUNT = 1: #CONTENT# в число дополнительных областей не входит. Чтобы узнать номер области конкретного шаблона, получите его CONTENT методом landing.template.getlist. Привязки страниц к областям сайта и отдельной страницы задают методы landing.template.setSiteRef и landing.template.setLandingRef.

Продолжите изучение