Получить список виджетов landing.repowidget.getlist
Scope:
landingКто может выполнять метод: любой пользователь
Метод landing.repowidget.getlist возвращает список виджетов текущего приложения, отобранных по фильтру.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
params* |
Массив полей для получения списка виджетов |
Параметр params
Обязательные параметры отмечены *
|
Название |
Описание |
|
select |
Массив со списком полей, которые необходимо выбрать. Если не передан или передан пустой массив, то будут выбраны все доступные доступные виджеты |
|
filter |
Объект для фильтрации выбранных записей в формате Возможные значения для Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
group |
Массив для группировки виджетов. Группировать можно по полям виджета |
|
order |
Объект для сортировки выбранных записей в формате Возможные значения для Возможные значения для
|
Поля field
Поля объекта виджета. Присутствуют в запросе и ответе.
|
Название |
Описание |
|
ID |
Идентификатор виджета |
|
XML_ID |
Уникальный код записи |
|
APP_CODE |
Код текущего приложения |
|
ACTIVE |
Активность виджета. Принимает значения:
|
|
NAME |
Название виджета |
|
DESCRIPTION |
Описание виджета |
|
SECTIONS |
Код раздела, в который будет добавлен виджет |
|
PREVIEW |
URL картинки-обложки виджета для слайдера выбора виджетов |
|
WIDGET_PARAMS |
Параметры для vue-шаблонизатора |
|
CONTENT |
Верстка виджета с использованием конструкций Vue |
|
MANIFEST |
Манифест виджета |
|
CREATED_BY_ID |
Идентификатор пользователя, создавшего запись |
|
MODIFIED_BY_ID |
Идентификатор пользователя, изменившего запись |
|
DATE_CREATE |
Дата создания |
|
DATE_MODIFY |
Дата изменения |
|
SITE_TEMPLATE_ID |
Привязка виджета к определенному шаблону сайта. Только для коробочного Битрикс24! |
Примеры кода
Как использовать примеры в документации
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
try {
const response = await $b24.callListMethod(
'landing.repowidget.getlist',
{
params: {
select: [
'ID', 'NAME'
],
filter: {
'>ID': '1'
}
}
},
(progress) => { console.log('Progress:', progress) }
)
const items = response.getData() || []
for (const entity of items) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
// fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
try {
const generator = $b24.fetchListMethod('landing.repowidget.getlist', {
params: {
select: [
'ID', 'NAME'
],
filter: {
'>ID': '1'
}
}
}, 'ID')
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error) {
console.error('Request failed', error)
}
// callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
try {
const response = await $b24.callMethod('landing.repowidget.getlist', {
params: {
select: [
'ID', 'NAME'
],
filter: {
'>ID': '1'
}
}
}, 0)
const result = response.getData().result || []
for (const entity of result) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
try {
$response = $b24Service
->core
->call(
'landing.repowidget.getlist',
[
'params' => [
'select' => [
'ID', 'NAME'
],
'filter' => [
'>ID' => '1'
]
]
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting repowidget list: ' . $e->getMessage();
}
BX24.callMethod(
'landing.repowidget.getlist',
{
params: {
select: [
'ID', 'NAME'
],
filter: {
'>ID': '1'
}
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.info(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'landing.repowidget.getList',
[
'params' => [
'select' => ['ID', 'NAME'],
'filter' => [
'>ID' => '1'
]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"ID": "4",
"XML_ID": "my_widget",
"APP_CODE": "app.code",
"ACTIVE": "Y",
"NAME": "My widget",
"DESCRIPTION": null,
"SECTIONS": "widgets_company_life",
"SITE_TEMPLATE_ID": null,
"PREVIEW": "https://my-app.com/vibe_preview.jpg",
"MANIFEST": {
"block": {
"type": [
"mainpage"
],
"subtype": [
"widgetvue"
],
"subtype_params": {
"rootNode": ".w-container",
"demoData": {
"desc": "JustSome widget data",
"count": "420",
},
"handler": "https://my-app.com/vibe.php",
"style": "https://my-app.com/vibe.css",
"lang": {
"ru": {
"W_TITLE": "Люди и их возраст",
"W_EMPTY": "Нет людей"
},
"en": {
"W_TITLE": "Widget title",
"W_EMPTY": "Empty!"
}
}
}
}
},
"CONTENT": "<div class=\"w-container\">{{desc}}</div>",
"CREATED_BY_ID": "1",
"MODIFIED_BY_ID": "1",
"DATE_CREATE": "10.10.2024 15:55:30",
"DATE_MODIFY": "16.10.2024 16:12:57"
}
],
"time": {
"start": 1729162340.81773,
"finish": 1729162344.800994,
"duration": 3.9832639694213867,
"processing": 3.8990869522094727,
"date_start": "2024-10-17T15:52:20+05:00",
"date_finish": "2024-10-17T15:52:24+05:00",
"operating": 3.899045944213867
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Массив виджетов. Каждый элемент массива — объект, допустимые поля описаны выше. |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить виджет на Главную страницу: наш вайб landing.repowidget.register
- Удалить виджет для Вайба landing.repowidget.unregister
- Включить режим отладки landing.repowidget.debug