метод REST scope: landing

landing.template.getlist

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

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

Описание

Метод landing.template.getlist получает список шаблонов представления текущего портала по параметрам выборки.

Параметры

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

Объект параметров выборки шаблонов представления формата:

{
    "select": ["поле_1", "поле_2"],
    "filter": {
        "поле": "значение"
    },
    "order": {
        "поле": "ASC"
    },
    "group": ["поле"],
    "limit": 50,
    "offset": 0
}

Список доступных полей описан ниже

Параметр params

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

Список полей из полей объекта Шаблон представления.

Если параметр не передан, метод возвращает все доступные поля шаблона.

Поля вида CREATED_BY.NAME не поддерживаются

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

Фильтр по полям из полей объекта Шаблон представления.

Если параметр не передан, метод возвращает все шаблоны текущего портала, включая неактивные.

Поля вида CREATED_BY.NAME не поддерживаются

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

Сортировка в формате {"FIELD": "ASC"} или {"FIELD": "DESC"}.

Можно передать несколько полей. Если параметр не передан, метод не задает собственную сортировку

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

Массив имен полей для группировки, например ["ACTIVE"] или ["ACTIVE", "SORT"].

Вычисляемые поля через runtime не поддерживаются

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

Максимальное количество элементов в ответе.

Если limit не указан, метод возвращает все найденные шаблоны без ограничения. Используйте вместе с offset для постраничной выборки

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

Смещение от начала выборки. Используйте вместе с limit для постраничной выборки

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

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "params": {
      "select": [
        "ID",
        "TITLE",
        "XML_ID",
        "SORT",
        "ACTIVE",
        "DATE_MODIFY"
      ],
      "filter": {
        "=ACTIVE": "Y"
      },
      "order": {
        "SORT": "ASC",
        "ID": "ASC"
      },
      "limit": 2,
      "offset": 0
    }
  }' \
  "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.template.getlist.json"

Ответ

HTTP-статус: 200

{
    "result": [
        {
            "ID": "1",
            "TITLE": "С шапкой и подвалом",
            "XML_ID": "header_footer",
            "SORT": "100",
            "ACTIVE": "Y",
            "DATE_MODIFY": "10/10/2022 03:25:30 pm"
        },
        {
            "ID": "2",
            "TITLE": "С сайдбаром слева",
            "XML_ID": "sidebar_left",
            "SORT": "200",
            "ACTIVE": "Y",
            "DATE_MODIFY": "10/10/2022 03:25:30 pm"
        }
    ],
    "time": {
        "start": 1774765200,
        "finish": 1774765200.411258,
        "duration": 0.4112579822540283,
        "processing": 0,
        "date_start": "2026-03-29T10:00:00+03:00",
        "date_finish": "2026-03-29T10:00:00+03:00",
        "operating_reset_at": 1774765800,
        "operating": 0
    }
}

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

result object[]

Список шаблонов представления (подробное описание).

Если по фильтру ничего не найдено, метод возвращает result: []

time time

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

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

HTTP-статус: 400

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

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

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