метод REST scope: landing

landing.landing.getList

Получить список страниц

Кто может выполнять: пользователь с правом «просмотр» сайта

Описание

Метод landing.landing.getList получает список страниц по параметрам выборки.

По умолчанию метод возвращает только страницы на неудаленных сайтах с DELETED = "N". Чтобы получить удаленные страницы, передайте в фильтре DELETED или =DELETED. Это работает только для страниц на неудаленных сайтах: страницы удаленных сайтов метод не возвращает

Параметры

scope string необязательный

Внутренний скоуп лендингов. Он не связан с REST-скоупом landing в названии метода.

Для обычных страниц параметр не нужен. Для GROUP, KNOWLEDGE и MAINPAGE передают соответствующий scope. Подробнее о выборе значения в статье Работа с типами сайтов и скоупами

params object необязательный

Параметры выборки страниц (подробное описание)

Параметр params

select string[] необязательный

Список полей для выборки из полей объекта Страница. Если параметр не передан или равен null, используется ["*"].

Метод принимает только простые имена полей страницы. Элементы с . игнорируются

filter object необязательный

Фильтр по полям из полей объекта Страница. Если параметр не передан или передан в неверном формате, выборка выполняется без пользовательских условий. Ключи с . и CHECK_PERMISSIONS игнорируются.

Если в фильтре передан SITE_ID, метод дополнительно исключает страницы, которые находятся в папках этого сайта, помеченных как удаленные.

Идентификатор сайта можно получить методом landing.site.getList

order object необязательный

Сортировка в формате {"FIELD": "ASC"} или {"FIELD": "DESC"}. Если параметр не передан, специальная сортировка не применяется

group array необязательный

Группировка в формате ORM. Собственного значения по умолчанию у метода нет

limit integer необязательный

Ограничение количества строк выборки на уровне ORM. Метод не задает собственный лимит по умолчанию

offset integer необязательный

Смещение выборки на уровне ORM

get_preview boolean необязательный

Если значение приводится к true, в каждый элемент результата добавляется поле PREVIEW со ссылкой на превью страницы

get_urls boolean необязательный

Если значение приводится к true, в каждый элемент результата добавляется поле PUBLIC_URL с публичным адресом страницы

check_area boolean необязательный

Если значение приводится к true, в каждый элемент результата добавляется поле IS_AREA, которое показывает, является ли страница включаемой областью

Примеры запроса

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "params": {
      "select": [
        "ID",
        "TITLE",
        "SITE_ID",
        "DATE_MODIFY"
      ],
      "filter": {
        "SITE_ID": 205,
        "=DELETED": "N"
      },
      "order": {
        "ID": "DESC"
      },
      "get_urls": true,
      "get_preview": true,
      "check_area": true
    }
  }' \
  "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.landing.getList.json"

Ответ

HTTP-статус: 200

{
    "result": [
        {
            "ID": "985",
            "TITLE": "Новость детально",
            "SITE_ID": "3",
            "DATE_MODIFY": "10/10/2022 03:25:30 pm",
            "DOMAIN_ID": "5"
        },
        {
            "ID": "573",
            "TITLE": "Page vide",
            "SITE_ID": "3",
            "DATE_MODIFY": "10/10/2022 03:25:30 pm",
            "DOMAIN_ID": "5"
        }
    ],
    "time": {
        "start": 1773712560,
        "finish": 1773712560.955928,
        "duration": 0.9559280872344971,
        "processing": 0,
        "date_start": "2026-03-17T04:56:00+03:00",
        "date_finish": "2026-03-17T04:56:00+03:00",
        "operating_reset_at": 1773713160,
        "operating": 0
    }
}

Возвращаемые данные

result object[]

Список страниц (подробное описание). Метод может вернуть result: [] без ошибки, если по фильтру нет подходящих страниц или у пользователя нет права «просмотр» для этих сайтов

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "ACCESS_DENIED",
    "error_description": "Access denied"
}
Код Описание Значение
ACCESS_DENIED Недостаточно прав для вызова метода
TYPE_ERROR Ошибка типа данных в параметрах вызова метода
SYSTEM_ERROR Внутренняя ошибка при выполнении метода

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.