Получить список источников biconnector.source.list

Scope: biconnector

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

Метод biconnector.source.list возвращает список источников по фильтру. Является реализацией списочного метода для источников.

Параметры метода

Название
тип

Описание

select
string[]

Список полей, которые должны быть заполнены у источников в выборке. По умолчанию берутся все поля

filter
object

Фильтр для выборки источников. Пример формата:

{
            "field_1": "value_1",
            "field_2": "value_2"
        }
        

К ключам field_n можно добавить префикс, уточняющий работу фильтра.
Возможные значения префикса:

  • >= — больше либо равно
  • > — больше
  • <= — меньше либо равно
  • < — меньше
  • @ — IN, в качестве значения передается массив
  • !@ — NOT IN, в качестве значения передается массив
  • % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
  • =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    • "мол%" — ищет значения, начинающиеся с «мол»
    • "%мол" — ищет значения, заканчивающиеся на «мол»
    • "%мол%" — ищет значения, где «мол» может быть в любой позиции
  • %= — LIKE (аналогично =%)
  • = — равно, точное совпадение (используется по умолчанию)
  • != — не равно
  • ! — не равно

Список доступных полей для фильтрации можно узнать с помощью метода biconnector.source.fields.

Фильтр не поддерживает поле settings, оно будет проигнорировано

order
object

Параметры сортировки. Пример формата:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }
        
  • field_n — название поля, по которому будет произведена сортировка выборки источников
  • value_n — значение типа string, равное:
    • ASC — сортировка по возрастанию
    • DESC — сортировка по убыванию

page
integer

Управление постраничной навигацией. Размер страницы результатов — 50 записей. Для перехода по результатам передавайте номер страницы

Примеры кода

Как использовать примеры в документации

Получить список источников, у которых:

  • название начинается на Sql
  • описание не пустое
  • идентификатор коннектора равен 2 или 4

Отобразить только необходимые поля:

  • идентификатор id
  • название title
  • активность active
  • дата создания dateCreate
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","title","active","dateCreate"],"filter":{"%=title":"Sql%","!description":"","@connectorId":[2,4]},"order":{"dateCreate":"DESC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.source.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","title","active","dateCreate"],"filter":{"%=title":"Sql%","!description":"","@connectorId":[2,4]},"order":{"dateCreate":"DESC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/biconnector.source.list
        
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        const selectFields = [
            "id",
            "title",
            "active",
            "dateCreate"
        ];
        
        try {
            const response = await $b24.callListMethod(
                'biconnector.source.list',
                {
                    select: selectFields,
                    filter: {
                        '%=title': "Sql%",
                        '!description': "",
                        "@connectorId": [2, 4]
                    },
                    order: {
                        dateCreate: "DESC"
                    }
                },
                (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: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
        
        const selectFields = [
            "id",
            "title",
            "active",
            "dateCreate"
        ];
        
        try {
            const generator = $b24.fetchListMethod('biconnector.source.list', {
                select: selectFields,
                filter: {
                    '%=title': "Sql%",
                    '!description': "",
                    "@connectorId": [2, 4]
                },
                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.
        
        const selectFields = [
            "id",
            "title",
            "active",
            "dateCreate"
        ];
        
        try {
            const response = await $b24.callMethod('biconnector.source.list', {
                select: selectFields,
                filter: {
                    '%=title': "Sql%",
                    '!description': "",
                    "@connectorId": [2, 4]
                },
                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.source.list',
                    [
                        'select' => [
                            "id",
                            "title",
                            "active",
                            "dateCreate"
                        ],
                        'filter' => [
                            '%=title'      => "Sql%",
                            '!description' => "",
                            "@connectorId" => [2, 4]
                        ],
                        '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 fetching source list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'biconnector.source.list',
            {
                select: [
                    "id",
                    "title",
                    "active",
                    "dateCreate"
                ],
                filter: {
                    '%=title': "Sql%",
                    '!description': "",
                    "@connectorId": [2, 4]
                },
                order: {
                    dateCreate: "DESC"
                }
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'biconnector.source.list',
            [
                'select' => [
                    "id",
                    "title",
                    "active",
                    "dateCreate"
                ],
                'filter' => [
                    '%=title' => "Sql%",
                    '!description' => "",
                    '@connectorId' => [2, 4]
                ],
                'order' => [
                    'dateCreate' => "DESC"
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Обработка ответа

HTTP-статус: 200

{
            "result": [
                {
                    "id": "11",
                    "title": "Sql_host",
                    "active": true,
                    "dateCreate": "2025-03-24 07:25:59"
                },
                {
                    "id": "10",
                    "title": "Sql_partner",
                    "active": false,
                    "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
object

Корневой элемент ответа. Содержит массив из объектов, содержащих информацию о полях источников.

Стоит учитывать, что структура полей может быть изменена из-за параметра select

time
time

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

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

HTTP-статус: 200

{
            "error": "VALIDATION_SELECT_TYPE",
            "error_description": "Parameter \"select\" must be array."
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

VALIDATION_SELECT_TYPE

Parameter "select" must be array.

В параметр select передан не объект

VALIDATION_FILTER_TYPE

Parameter "filter" must be array.

В параметр filter передан не объект

VALIDATION_ORDER_TYPE

Parameter "order" must be array.

В параметр order передан не объект

VALIDATION_FIELD_NOT_ALLOWED_IN_SELECT

Field "#TITLE#" is not allowed in the "select".

Данные поля недопустимы в выборке

VALIDATION_FIELD_NOT_ALLOWED_IN_FILTER

Field "#TITLE#" is not allowed in the "filter".

Данные поля недопустимы в фильтре

VALIDATION_FIELD_NOT_ALLOWED_IN_ORDER

Field "#TITLE#" is not allowed in the "order".

Данные поля недопустимы для сортировки

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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