Поля сайта

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

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

Поля сайта описывают название, адрес, тип, статус публикации и служебные страницы сайта. Метод landing.site.getList возвращает эти поля, методы landing.site.add и landing.site.update принимают часть из них в параметре fields.

Дополнительные поля сайта, например тема, фон, аналитика и пользовательский код, в эту таблицу не входят. Их передают в массиве ADDITIONAL_FIELDS и читают методом landing.site.getadditionalfields. Описание — в статье Дополнительные поля сайта.

Scope: landing

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

Как получить поля сайта

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

{
    "params": {
        "select": ["ID", "TITLE", "ACTIVE", "PUBLIC_URL"],
        "filter": {
            "=XML_ID": "my-integration-site-1"
        }
    }
}

Если select не передан, метод возвращает все поля из таблиц основных и служебных полей. Вычисляемые поля возвращаются, только если указать их в select. Поля ID и TYPE метод добавляет в выборку всегда.

По умолчанию landing.site.getList возвращает только сайты со значением DELETED = "N". Чтобы получить сайты из корзины, передайте DELETED или =DELETED в filter.

Что нужно знать

при создании через landing.site.add сайт создается неопубликованным со значением ACTIVE = "N"
поля ACTIVE, SPECIAL и TPL_CODE методы landing.site.add и landing.site.update не сохраняют: значения из fields игнорируются без ошибки. Публикацией управляют методы landing.site.publication и landing.site.unpublic
если сайт поместить в корзину, он автоматически снимается с публикации
для удаления и восстановления сайта используйте landing.site.markDelete и landing.site.markUnDelete
поля CREATED_BY_ID, MODIFIED_BY_ID, DATE_CREATE и DATE_MODIFY Битрикс24 заполняет автоматически при создании и изменении сайта

Основные поля

Поле `тип`	Описание
ID `integer`	Идентификатор сайта. В `landing.site.getList` поле всегда присутствует в ответе
TITLE `string`	Название сайта. Поле обязательно при создании
CODE `string`	Символьный код сайта. В ответе `landing.site.getList` возвращается в формате `/code/`. При создании и изменении можно передавать значение без крайних `/`. Если передать пустую строку, код сгенерируется из `TITLE` или из строки `site`. Код из одних цифр получает префикс `site`
TYPE `string`	Тип сайта. Возможные значения: `PAGE` — сайт `STORE` — магазин `SMN` — проект `KNOWLEDGE` — база знаний `GROUP` — сайт группы `MAINPAGE` — главная страница или вайб По умолчанию `PAGE` Подробно о типах и внутренних scope читайте в статье Работа с типами сайтов и скоупами
ACTIVE `string`	Статус публикации сайта. Возможные значения: `Y` — сайт опубликован `N` — сайт не опубликован При создании через `landing.site.add` сайт получает значение `N`. Через `landing.site.add` и `landing.site.update` поле не меняется. Для публикации и снятия с публикации используйте landing.site.publication и landing.site.unpublic
DELETED `string`	Флаг корзины. Возможные значения: `Y` — сайт находится в корзине `N` — сайт не находится в корзине По умолчанию `landing.site.getList` возвращает только сайты со значением `DELETED = "N"`
DESCRIPTION `string`	Краткое описание сайта. Выводится в списке сайтов
XML_ID `string`	Внешний идентификатор сайта. Удобен, чтобы находить сайт из интеграции и не хранить внутренний `ID`
DOMAIN_ID `integer` \| `string`	Идентификатор домена. Доменное имя возвращает вычисляемое поле `DOMAIN_NAME`
LANG `string`	Двухсимвольный код языковой зоны сайта, например `ru`, `en`, `de`, `by`, `kz`, `in`. Может быть пустой строкой, если язык сайта не задан
TPL_ID `integer`	Идентификатор шаблона представления сайта
LANDING_ID_INDEX `integer`	Идентификатор главной страницы сайта. Это поле также используется для получения `PREVIEW_PICTURE`
LANDING_ID_404 `integer`	Идентификатор страницы ошибки `404`
LANDING_ID_503 `integer`	Идентификатор страницы ошибки `503`
CREATED_BY_ID `integer`	Идентификатор пользователя, который создал сайт
MODIFIED_BY_ID `integer`	Идентификатор пользователя, который последним изменил сайт
DATE_CREATE `datetime`	Дата и время создания сайта. В ответе REST возвращается строкой. Формат зависит от региональных настроек портала, например `04/20/2020 12:48:10 pm`. Значение в формате ISO 8601 возвращает поле `DATE_CREATE_ISO`
DATE_MODIFY `datetime`	Дата и время последнего изменения сайта. В ответе REST возвращается строкой. Формат зависит от региональных настроек портала, например `04/20/2020 12:48:10 pm`. Значение в формате ISO 8601 возвращает поле `DATE_MODIFY_ISO`

Служебные поля

Эти поля Битрикс24 заполняет сам. Метод landing.site.getList возвращает их при запросе без select или с явным указанием в select. Передавать их в landing.site.add и landing.site.update не нужно.

Поле `тип`	Описание
TPL_CODE `string` \| `null`	Код шаблона типового решения, из которого создан сайт, например `clothes`. Если сайт создан не из типового решения, возвращается `null`. Значение из `fields` методы `landing.site.add` и `landing.site.update` игнорируют
SPECIAL `string`	Признак технического сайта. Возможные значения: `Y` — технический сайт, например сайт для CRM-форм `N` — обычный сайт По умолчанию `N`. Значение из `fields` методы `landing.site.add` и `landing.site.update` игнорируют
SMN_SITE_ID `string` \| `null`	Идентификатор сайта главного модуля, к которому привязан сайт. Если привязки нет, возвращается `null`
VERSION `integer`	Внутренняя версия сайта

Вычисляемые поля

Эти поля не хранятся в таблице сайта. Метод landing.site.getList формирует их при ответе.

Поле `тип`	Описание
DOMAIN_NAME `string`	Доменное имя сайта. Возвращается, если указать поле в `select`
PUBLIC_URL `string`	Полный публичный URL сайта. Может быть пустой строкой, если URL не удалось определить. Возвращается, если указать поле в `select`
PREVIEW_PICTURE `string`	URL превью главной страницы сайта. Может быть пустой строкой, если превью недоступно. Возвращается, если указать поле в `select`
PHONE `string` \| `null`	Телефон CRM-контакта, связанного с сайтом. Возвращается, если указать поле в `select`
DATE_CREATE_ISO `string`	Дата и время создания сайта в формате ISO 8601, например `2020-04-20T12:48:10+03:00`. Возвращается вместе с `DATE_CREATE`
DATE_MODIFY_ISO `string`	Дата и время последнего изменения сайта в формате ISO 8601. Возвращается вместе с `DATE_MODIFY`

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

создать сайт и изменить его поля — Добавить сайт landing.site.add, Изменить сайт landing.site.update
получить список сайтов с выбранными полями — Получить список сайтов landing.site.getList
опубликовать сайт или снять его с публикации — Опубликовать сайт landing.site.publication, Снять сайт с публикации landing.site.unpublic
получить публичный адрес и превью сайта — Получить публичный URL сайта landing.site.getPublicUrl, Получить URL превью сайта landing.site.getPreview
работать с дополнительными полями сайта — Дополнительные поля сайта, Получить дополнительные поля сайта landing.site.getadditionalfields
выбрать тип сайта и внутренний scope — Работа с типами сайтов и скоупами

Была ли статья полезна?

Обзор методов

Дополнительные поля

Поля сайта

Как получить поля сайтаКак получить поля сайта

Что нужно знатьЧто нужно знать

Основные поляОсновные поля

Служебные поляСлужебные поля

Вычисляемые поляВычисляемые поля

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