Получить список источников biconnector.source.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
biconnectorКто может выполнять метод: пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно
Метод biconnector.source.list возвращает список источников по фильтру.
Метод работает только в контексте приложения и возвращает только те источники, которые приложение создало само. При вызове вебхуком метод возвращает ошибку ACCESS_DENIED
Размер страницы результатов — 50 записей. Метод не возвращает ни общее количество источников, ни ссылку на следующую страницу, поэтому обход списка строится по номеру страницы: выборка закончилась, когда в ответе пришло меньше 50 записей.
Параметры метода
Все параметры необязательные: метод можно вызвать с пустым телом запроса.
|
Название |
Описание |
|
select |
Список полей, которые должны быть заполнены у источников в выборке. Допустимые значения — названия полей из схемы метода biconnector.source.fields и Если передать в |
|
filter |
Фильтр для выборки источников. Пример формата:
К ключам
Список доступных полей для фильтрации можно узнать с помощью метода biconnector.source.fields. Ключ
Любое другое значение ключа Фильтр не поддерживает поле |
|
order |
Параметры сортировки. Пример формата:
Без этого параметра сортировка не применяется и порядок записей в выборке не гарантирован. Значение направления регистронезависимо, но других значений поле не принимает. Пустая строка, число или любое слово кроме Сортировка, как и фильтр, не работает по полю |
|
page |
Номер страницы результатов. Нумерация начинается с единицы, значение по умолчанию — 1. Нечисловое, нулевое или отрицательное значение ошибки не вызывает: метод молча отдает первую страницу. Параметр |
Примеры кода
Как использовать примеры в документации
Получить список источников, у которых:
- название начинается на
Sql - описание не пустое
- идентификатор коннектора равен
2или4
Вернуть только нужные поля:
- идентификатор
id - название
title - активность
active - описание
description
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","title","active","description"],"filter":{"%=title":"Sql%","!description":"","@connectorId":[2,4]},"order":{"dateCreate":"DESC"},"page":1,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/biconnector.source.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Methods of this section put errors inside result and answer with HTTP 200
type BiconnectorError = {
error: {
error: string
error_description: string
}
}
// Shape of each SourceItem returned in result[]
type SourceItem = {
id: number
title: string
active: boolean
description: string
}
try {
// biconnector.source.list returns a single page (max 50 records). The list helpers
// ($b24.actions.v2.callList.make, fetchList.make) do not work here: this method uses
// its own `page` navigation and returns neither `total` nor `next`. Walk the pages
// yourself, increasing `page` until a response comes back with fewer than 50 records.
const response = await $b24.actions.v2.call.make<SourceItem[] | BiconnectorError>({
method: 'biconnector.source.list',
params: {
select: ['id', 'title', 'active', 'description'],
filter: {
'%=title': 'Sql%',
'!description': '',
'@connectorId': [2, 4],
},
order: {
dateCreate: 'DESC',
},
page: 1,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
// The SDK sees HTTP 200 as success, so check the error inside result yourself
if (!Array.isArray(result)) {
console.error(result.error.error, result.error.error_description)
} else {
console.info('Sources fetched:', result.length, result)
}
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function fetchSourceList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// biconnector.source.list returns a single page (max 50 records). The list helpers
// ($b24.actions.v2.callList.make, fetchList.make) do not work here: this method uses
// its own `page` navigation and returns neither `total` nor `next`. Walk the pages
// yourself, increasing `page` until a response comes back with fewer than 50 records.
const response = await $b24.actions.v2.call.make({
method: 'biconnector.source.list',
params: {
select: ['id', 'title', 'active', 'description'],
filter: {
'%=title': 'Sql%',
'!description': '',
'@connectorId': [2, 4],
},
order: {
dateCreate: 'DESC',
},
page: 1,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
// The SDK sees HTTP 200 as success, so check the error inside result yourself
if (result && result.error) {
console.error(result.error.error, result.error.error_description)
return
}
console.info('Sources fetched:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchSourceList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.biconnector.source.list(
select=[
"id",
"title",
"active",
"description",
],
filter={
"%=title": "Sql%",
"!description": "",
"@connectorId": [
2,
4,
],
},
order={
"dateCreate": "DESC",
},
page=1,
).response
result = bitrix_response.result
# Методы раздела кладут ошибку внутрь result и отвечают со статусом 200
if isinstance(result, dict) and "error" in result:
print(
"Ошибка BIconnector",
f"error: {result['error']['error']}",
f"error_description: {result['error']['error_description']}",
sep="\n",
)
else:
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'biconnector.source.list',
[
'select' => [
"id",
"title",
"active",
"description"
],
'filter' => [
'%=title' => "Sql%",
'!description' => "",
"@connectorId" => [2, 4]
],
'order' => [
'dateCreate' => "DESC"
],
'page' => 1
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
$data = $result->data();
// Методы раздела кладут ошибку внутрь result и отвечают со статусом 200
if (isset($data['error'])) {
echo 'BIconnector error: ' . $data['error']['error'] . ': ' . $data['error']['error_description'];
} else {
echo 'Data: ' . print_r($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",
"description"
],
filter: {
'%=title': "Sql%",
'!description': "",
"@connectorId": [2, 4]
},
order: {
dateCreate: "DESC"
},
page: 1
},
(result) => {
if (result.error()) {
console.error(result.error());
return;
}
const data = result.data();
// Методы раздела кладут ошибку внутрь result и отвечают со статусом 200
if (data && data.error) {
console.error(data.error.error, data.error.error_description);
return;
}
console.info(data);
}
);
require_once('crest.php');
$result = CRest::call(
'biconnector.source.list',
[
'select' => [
"id",
"title",
"active",
"description"
],
'filter' => [
'%=title' => "Sql%",
'!description' => "",
'@connectorId' => [2, 4]
],
'order' => [
'dateCreate' => "DESC"
],
'page' => 1
]
);
// Методы раздела кладут ошибку внутрь result и отвечают со статусом 200
if (isset($result['result']['error'])) {
echo 'BIconnector error: ' . $result['result']['error']['error']
. ': ' . $result['result']['error']['error_description'];
} else {
echo '<PRE>';
print_r($result);
echo '</PRE>';
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "biconnector.source.list", b24.Params{
"select": []string{"id", "title", "active", "description"},
"filter": b24.Params{
"%=title": "Sql%",
"!description": "",
"@connectorId": []int{2, 4},
},
"order": b24.Params{
"dateCreate": "DESC",
},
"page": 1,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("biconnector.source.list: %w", err)
}
// Методы раздела кладут ошибку внутрь result и отвечают со статусом 200.
var apiErr struct {
Error *struct {
Error string `json:"error"`
Description string `json:"error_description"`
} `json:"error"`
}
if err := json.Unmarshal(res.Result, &apiErr); err == nil && apiErr.Error != nil {
return fmt.Errorf("biconnector.source.list: %s: %s", apiErr.Error.Error, apiErr.Error.Description)
}
var items []struct {
ID b24.ID `json:"id"`
Title string `json:"title"`
Active bool `json:"active"`
Description string `json:"description"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Title)
}
// Total и Next этот метод не возвращает: постраничный обход
// строится по параметру page, пока в ответе приходит 50 записей.
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"id": 11,
"title": "Sql_host",
"active": true,
"description": "Подключение для отчетов по хостам"
},
{
"id": 10,
"title": "Sql_partner",
"active": false,
"description": "Подключение для отчетов по партнерам"
}
],
"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 |
Информация о времени выполнения запроса |
Элемент массива result
|
Название |
Описание |
|
id |
Уникальный идентификатор источника |
|
title |
Название источника |
|
type |
Тип источника. У источников, созданных через REST, значение всегда равно |
|
code |
Код источника. Формируется автоматически по шаблону |
|
description |
Описание источника |
|
active |
Активность источника. Неактивный источник перестает отдавать данные |
|
dateCreate |
Дата создания источника в формате |
|
dateUpdate |
Дата обновления источника в формате |
|
createdById |
Идентификатор пользователя, создавшего источник |
|
updatedById |
Идентификатор пользователя, обновившего источник |
|
connectorId |
Идентификатор коннектора, к которому привязан источник |
|
settings |
Параметры авторизации источника. Структура элемента — в разделе Поле settings |
Если задан параметр select, в элементах остаются только перечисленные поля.
Обработка ошибок
HTTP-статус: 200
{
"result": {
"error": {
"error": "VALIDATION_SELECT_TYPE",
"error_description": "Parameter \"select\" must be array."
}
}
}
Метод возвращает ошибку внутри поля result и с HTTP-статусом 200. Проверяйте result.error: обертки SDK разбирают только верхний уровень ответа и такую ошибку считают успехом
Одна ошибка метода приходит иначе. Если в параметре order передать направление сортировки, отличное от ASC и DESC, запрос обрывается на уровне ORM: ответ получает HTTP-статус 400, а код ошибки лежит в корне, а не внутри result.
{
"error": "ERROR_ARGUMENT",
"error_description": "Invalid order \"UPWARDS\""
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Access denied. |
Нет одного из двух прав, либо метод вызван вебхуком или вне контекста приложения |
|
|
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". |
Поле |
|
|
Invalid order "#VALUE#". |
Направление сортировки в |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |