метод REST scope: biconnector

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

Ответ

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". Данные поля недопустимы для сортировки

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.