Получить список датасетов biconnector.dataset.list

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: biconnector

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

Метод 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 записей. Для перехода по результатам передавайте номер страницы

Примеры кода

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

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

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

Для наглядности выбрать только необходимые поля:

  • идентификатор id
  • название name
  • описание description
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>
        
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."
        }
        

Название
тип

Описание

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

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

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

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