biconnector.dataset.list
Получить список датасетов
Описание
Метод biconnector.dataset.list возвращает список датасетов по фильтру. Является реализацией списочного метода для датасетов.
Параметры
select
string[]
необязательный
Список полей, которые должны быть заполнены у датасетов в выборке. По умолчанию берутся все поля.
Не поддерживает поле fields, оно будет проигнорировано
filter
object
необязательный
Фильтр для выборки датасетов. Пример формата:
{
"field_1": "value_1",
"field_2": "value_2"
}
К ключам field_n можно добавить префикс, уточняющий работу фильтра.
Возможные значения префикса:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- @ — IN, в качестве значения передается массив
- !@ — NOT IN, в качестве значения передается массив
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, начинающиеся с «мол»
- "%мол" — ищет значения, заканчивающиеся на «мол»
- "%мол%" — ищет значения, где «мол» может быть в любой позиции
- %= — LIKE (аналогично =%)
- = — равно, точное совпадение (используется по умолчанию)
- != — не равно
- ! — не равно
Список доступных полей для фильтрации можно узнать с помощью метода biconnector.dataset.fields.
Фильтр не поддерживает поле fields, оно будет проигнорировано
order
object
необязательный
Параметры сортировки. Пример формата:
{
field_1: value_1,
field_2: value_2,
...,
field_n: value_n,
}
где:
- field_n — название поля, по которому будет произведена сортировка выборки датасетов
- value_n — значение типа string, равное:
- ASC — сортировка по возрастанию
- DESC — сортировка по убыванию
page
integer
необязательный
Управление постраничной навигацией. Размер страницы результатов — 50 записей. Для перехода по результатам передавайте номер страницы
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"select": ["id", "name", "description"],
"filter": {
"%=name": "Sales%",
"!description": "",
"@sourceId": [2, 4]
},
"order": {
"dateCreate": "DESC"
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.dataset.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"select": ["id", "name", "description"],
"filter": {
"%=name": "Sales%",
"!description": "",
"@sourceId": [2, 4]
},
"order": {
"dateCreate": "DESC"
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/biconnector.dataset.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
// Shape of each DatasetItem returned in result[]
type DatasetItem = {
id: string
name: string
description: string
}
try {
// biconnector.dataset.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<DatasetItem[]>({
method: 'biconnector.dataset.list',
params: {
select: ['id', 'name', 'description'],
filter: {
'%=name': 'Sales%',
'!description': '',
'@sourceId': [2, 4],
},
order: {
dateCreate: 'DESC',
},
start: 0,
},
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
console.info('Datasets page:', 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 listDatasets() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// biconnector.dataset.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'biconnector.dataset.list',
params: {
select: ['id', 'name', 'description'],
filter: {
'%=name': 'Sales%',
'!description': '',
'@sourceId': [2, 4],
},
order: {
dateCreate: 'DESC',
},
start: 0,
},
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
console.info('Datasets page:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listDatasets)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.biconnector.dataset.list(
select=[
"id",
"name",
"description",
],
filter={
"%=name": "Sales%",
"!description": "",
"@sourceId": [
2,
4,
],
},
order={
"dateCreate": "DESC",
},
).response
result = bitrix_response.result
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.dataset.list',
[
'select' => ["id", "name", "description"],
'filter' => [
'%=name' => "Sales%",
'!description' => "",
"@sourceId" => [2, 4]
],
'order' => [
'dateCreate' => "DESC"
]
]
);
$result = $response
->getResponseData()
->getResult();
if ($response->getError()) {
error_log($response->getError());
echo 'Error: ' . $response->getError();
} else {
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error calling biconnector.dataset.list: ' . $e->getMessage();
}
BX24.callMethod(
'biconnector.dataset.list',
{
select: ["id", "name", "description"],
filter: {
'%=name': "Sales%",
'!description': "",
"@sourceId": [2, 4]
},
order: {
dateCreate: "DESC"
}
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'biconnector.dataset.list',
[
'select' => ["id", "name", "description"],
'filter' => ['%=name' => "Sales%", '!description' => "", '@sourceId' => [2, 4]],
'order' => ['dateCreate' => "DESC"]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "biconnector.dataset.list", b24.Params{
"select": []string{"id", "name", "description"},
"filter": b24.Params{
"%=name": "Sales%",
"!description": "",
"@sourceId": []int{2, 4},
},
"order": b24.Params{
"dateCreate": "DESC",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("biconnector.dataset.list: %w", err)
}
var items []struct {
ID b24.ID `json:"id"`
Name string `json:"name"`
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.Name)
}
// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
fmt.Println("всего:", *res.Total)
}
Ответ
HTTP-статус: 200
{
"result": [
{
"id": "9",
"name": "sales_data_main",
"description": "Monthly sales report"
},
{
"id": "6",
"name": "sales_data_first_filial",
"description": "Monthly sales report for first filial"
},
{
"id": "5",
"name": "sales_data_second_filial",
"description": "Monthly sales report for second filial"
}
],
"time": {
"start": 1743061675.963969,
"finish": 1743061676.064591,
"duration": 0.10062193870544434,
"processing": 0.011152029037475586,
"date_start": "2025-03-27T07:47:55+00:00",
"date_finish": "2025-03-27T07:47:56+00:00"
}
}
Возвращаемые данные
result
array
Корневой элемент ответа. Содержит массив объектов с информацией о датасетах.
Стоит учитывать, что структура полей может быть изменена из-за параметра select
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 200
{
"error": "VALIDATION_SELECT_TYPE",
"error_description": "Parameter \"select\" must be array."
}
| Код | Описание | Значение |
|---|---|---|
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". | Данные поля недопустимы для сортировки |

