Получить список коннекторов biconnector.connector.list
Scope:
biconnectorКто может выполнять метод: пользователь с доступом к разделу «Рабочее место аналитика»
Метод biconnector.connector.list возвращает список коннекторов по фильтру. Является реализацией списочного метода для коннекторов.
Параметры метода
|
Название |
Описание |
|
select |
Список полей, которые должны быть заполнены у коннекторов в выборке. По умолчанию берутся все поля |
|
filter |
Фильтр для выборки коннекторов. Пример формата:
К ключам
Список доступных полей для фильтрации можно узнать с помощью метода biconnector.connector.fields |
|
order |
Параметры сортировки. Пример формата:
|
|
page |
Управление постраничной навигацией. Размер страницы результатов — 50 записей. Для перехода по результатам передавайте номер страницы |
Примеры кода
Как использовать примеры в документации
Получить список коннекторов, у которых:
- название начинается на
MyConnector - описание не пустое
Отобразить только необходимые поля:
- идентификатор
id - название
title - эдпоинт для проверки доступности источника
urlCheck - дата создания
dateCreate
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"SELECT": [
"id",
"title",
"urlCheck",
"dateCreate"
],
"FILTER": {
"%=title": "MyConnector%",
"!description": ""
},
"ORDER": {
"dateCreate": "DESC"
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.connector.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"SELECT": [
"id",
"title",
"urlCheck",
"dateCreate"
],
"FILTER": {
"%=title": "MyConnector%",
"!description": ""
},
"ORDER": {
"dateCreate": "DESC"
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/biconnector.connector.list
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
try {
const response = await $b24.callListMethod(
'biconnector.connector.list',
{
select: [
"id",
"title",
"urlCheck",
"dateCreate"
],
filter: {
'%=title': "MyConnector%",
'!description': ''
},
order: {
dateCreate: "DESC"
}
},
(progress) => {
result.error()
? console.error(result.error())
: console.info(result.data());
}
);
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('biconnector.connector.list', {
select: [
"id",
"title",
"urlCheck",
"dateCreate"
],
filter: {
'%=title': "MyConnector%",
'!description': ''
},
order: {
dateCreate: "DESC"
}
}, '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('biconnector.connector.list', {
select: [
"id",
"title",
"urlCheck",
"dateCreate"
],
filter: {
'%=title': "MyConnector%",
'!description': ''
},
order: {
dateCreate: "DESC"
}
}, 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(
'biconnector.connector.list',
[
'select' => [
"id",
"title",
"urlCheck",
"dateCreate"
],
'filter' => [
'%=title' => "MyConnector%",
'!description' => ''
],
'order' => [
'dateCreate' => "DESC"
]
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error calling biconnector.connector.list: ' . $e->getMessage();
}
BX24.callMethod(
'biconnector.connector.list',
{
select: [
"id",
"title",
"urlCheck",
"dateCreate"
],
filter: {
'%=title': "MyConnector%",
'!description': ''
},
order: {
dateCreate: "DESC"
}
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'biconnector.connector.list',
[
'select' => [
"id",
"title",
"urlCheck",
"dateCreate"
],
'filter' => [
'%=title' => "MyConnector%",
'!description' => ''
],
'order' => [
'dateCreate' => "DESC"
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"id": "11",
"title": "MyConnector_2",
"urlCheck": "https://new_example.com/check",
"dateCreate": "2025-03-24 07:25:59"
},
{
"id": "9",
"title": "MyConnector",
"urlCheck": "https://example.com/check",
"dateCreate": "2025-03-21 12:22:32"
}
],
"time": {
"start": 1742804947.923552,
"finish": 1742804947.995446,
"duration": 0.07189393043518066,
"processing": 0.0017020702362060547,
"date_start": "2025-03-24T08:29:07+00:00",
"date_finish": "2025-03-24T08:29:07+00:00"
}
}
Возвращаемые данные
|
result |
Корневой элемент ответа. Содержит массив из объектов, содержащих информацию о полях коннекторов. Стоит учитывать, что структура полей может быть изменена из-за параметра |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 200
{
"error": "VALIDATION_SELECT_TYPE",
"error_description": "Parameter \"select\" must be array."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Parameter "select" must be array. |
В параметр |
|
|
Parameter "filter" must be array. |
В параметр |
|
|
Parameter "order" must be array. |
В параметр |
|
|
Field "#TITLE#" is not allowed in the "select". |
Данные поля недопустимы в выборке |
|
|
Field "#TITLE#" is not allowed in the "filter". |
Данные поля недопустимы в фильтре |
|
|
Field "#TITLE#" is not allowed in the "order". |
Данные поля недопустимы для сортировки |
|
|
Field "logic" must be either "AND" or "OR". |
Поле |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Изменить коннектор biconnector.connector.update
- Получить коннектор по id biconnector.connector.get
- Создать коннектор biconnector.connector.add
- Удалить коннектор biconnector.connector.delete
- Получить поля коннектора biconnector.connector.fields