Создать датасет biconnector.dataset.add

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

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

Scope: biconnector

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

Метод biconnector.dataset.add создает новый датасет, связанный с источником данных.

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

Обязательные параметры отмечены *

Название
тип

Описание

fields*
object

Объект, содержащий данные для создания нового датасета. Формат объекта:

{
            "field_1": "value_1",
            "field_2": "value_2",
            ...,
            "field_n": "value_n"
        }
        
  • field_n — название поля
  • value_n — значение поля

Подробное описание ниже

Параметр fields

Название
тип

Описание

name*
string

Название датасета. Название должно начинаться с буквы, можно использовать только строчные латинские буквы a-z, цифры и знак _. Максимальная длина названия 230 символа

externalName*
string

Название датасета во внешнем источнике, в приложении

externalCode*
string

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

sourceId*
integer

Идентификатор источника, можно получить методами biconnector.source.list или biconnector.source.add

description
string

Описание датасета

fields*
array

Список полей датасета, (Подробное описание)

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "fields": {
                "sourceId": 3,
                "name": "rest_dataset",
                "externalName": "extranalName",
                "externalCode": "extrnalCode",
                "description": "Описание датасета",
                "fields": [
                    { "type": "int", "name": "ID", "externalCode": "ID" },
                    { "type": "string", "name": "NAME", "externalCode": "NAME" },
                    { "type": "string", "name": "SURNAME", "externalCode": "SURNAME" },
                    { "type": "double", "name": "SCORE", "externalCode": "SCORE" },
                    { "type": "date", "name": "DATA", "externalCode": "DATA" },
                    { "type": "datetime", "name": "TIME", "externalCode": "TIME" }
                ]
            }
        }' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.dataset.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "fields": {
                "sourceId": 3,
                "name": "rest_dataset",
                "externalName": "extranalName",
                "externalCode": "extrnalCode",
                "description": "Описание датасета",
                "fields": [
                    { "type": "int", "name": "ID", "externalCode": "ID" },
                    { "type": "string", "name": "NAME", "externalCode": "NAME" },
                    { "type": "string", "name": "SURNAME", "externalCode": "SURNAME" },
                    { "type": "double", "name": "SCORE", "externalCode": "SCORE" },
                    { "type": "date", "name": "DATA", "externalCode": "DATA" },
                    { "type": "datetime", "name": "TIME", "externalCode": "TIME" }
                ]
            },
            "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/biconnector.dataset.add
        
// 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 the payload returned in result (match the "response handling" section of the page)
        type DatasetAddResult = {
          id: number
        }
        
        try {
          const response = await $b24.actions.v2.call.make<DatasetAddResult>({
            method: 'biconnector.dataset.add',
            params: {
              fields: {
                sourceId: 3,
                name: 'rest_dataset',
                externalName: 'extranalName',
                externalCode: 'extrnalCode',
                description: 'Dataset description',
                fields: [
                  { type: 'int', name: 'ID', externalCode: 'ID' },
                  { type: 'string', name: 'NAME', externalCode: 'NAME' },
                  { type: 'string', name: 'SURNAME', externalCode: 'SURNAME' },
                  { type: 'double', name: 'SCORE', externalCode: 'SCORE' },
                  { type: 'date', name: 'DATA', externalCode: 'DATA' },
                  { type: 'datetime', name: 'TIME', externalCode: 'TIME' },
                ],
              },
            },
            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('Created dataset id:', result.id)
          }
        } 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 addDataset() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'biconnector.dataset.add',
                params: {
                  fields: {
                    sourceId: 3,
                    name: 'rest_dataset',
                    externalName: 'extranalName',
                    externalCode: 'extrnalCode',
                    description: 'Dataset description',
                    fields: [
                      { type: 'int', name: 'ID', externalCode: 'ID' },
                      { type: 'string', name: 'NAME', externalCode: 'NAME' },
                      { type: 'string', name: 'SURNAME', externalCode: 'SURNAME' },
                      { type: 'double', name: 'SCORE', externalCode: 'SCORE' },
                      { type: 'date', name: 'DATA', externalCode: 'DATA' },
                      { type: 'datetime', name: 'TIME', externalCode: 'TIME' },
                    ],
                  },
                },
                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('Created dataset id:', result.id)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addDataset)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'biconnector.dataset.add',
                    [
                        'fields' => [
                            'sourceId'      => 3,
                            'name'          => 'rest_dataset',
                            'externalName'  => 'extranalName',
                            'externalCode'  => 'extrnalCode',
                            'description'   => 'Описание датасета',
                            'fields'        => [
                                ['type' => 'int', 'name' => 'ID', 'externalCode' => 'ID'],
                                ['type' => 'string', 'name' => 'NAME', 'externalCode' => 'NAME'],
                                ['type' => 'string', 'name' => 'SURNAME', 'externalCode' => 'SURNAME'],
                                ['type' => 'double', 'name' => 'SCORE', 'externalCode' => 'SCORE'],
                                ['type' => 'date', 'name' => 'DATA', 'externalCode' => 'DATA'],
                                ['type' => 'datetime', 'name' => 'TIME', 'externalCode' => 'TIME'],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding dataset: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'biconnector.dataset.add',
            {
                fields: {
                    "sourceId": 3,
                    "name": "rest_dataset",
                    "externalName": "extranalName",
                    "externalCode": "extrnalCode",
                    "description": "Описание датасета",
                    "fields": [
                        { "type": "int", "name": "ID", "externalCode": "ID" },
                        { "type": "string", "name": "NAME", "externalCode": "NAME" },
                        { "type": "string", "name": "SURNAME", "externalCode": "SURNAME" },
                        { "type": "double", "name": "SCORE", "externalCode": "SCORE" },
                        { "type": "date", "name": "DATA", "externalCode": "DATA" },
                        { "type": "datetime", "name": "TIME", "externalCode": "TIME" }
                    ]
                }
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'biconnector.dataset.add',
            [
                'fields' => [
                    'sourceId' => 3,
                    'name' => 'rest_dataset',
                    'externalName' => 'extranalName',
                    'externalCode' => 'extrnalCode',
                    'description' => 'Описание датасета',
                    'fields' => [
                        [ 'type' => 'int', 'name' => 'ID', 'externalCode' => 'ID' ],
                        [ 'type' => 'string', 'name' => 'NAME', 'externalCode' => 'NAME' ],
                        [ 'type' => 'string', 'name' => 'SURNAME', 'externalCode' => 'SURNAME' ],
                        [ 'type' => 'double', 'name' => 'SCORE', 'externalCode' => 'SCORE' ],
                        [ 'type' => 'date', 'name' => 'DATA', 'externalCode' => 'DATA' ],
                        [ 'type' => 'datetime', 'name' => 'TIME', 'externalCode' => 'TIME' ]
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client и ctx уже созданы — см. раздел «SDK для Go»
        res, err := client.Core().Call(ctx, "biconnector.dataset.add", b24.Params{
        	"fields": b24.Params{
        		"sourceId":     3,
        		"name":         "rest_dataset",
        		"externalName": "extranalName",
        		"externalCode": "extrnalCode",
        		"description":  "Описание датасета",
        		"fields": []b24.Params{
        			{
        				"type":         "int",
        				"name":         "ID",
        				"externalCode": "ID",
        			},
        			{
        				"type":         "string",
        				"name":         "NAME",
        				"externalCode": "NAME",
        			},
        			{
        				"type":         "string",
        				"name":         "SURNAME",
        				"externalCode": "SURNAME",
        			},
        			{
        				"type":         "double",
        				"name":         "SCORE",
        				"externalCode": "SCORE",
        			},
        			{
        				"type":         "date",
        				"name":         "DATA",
        				"externalCode": "DATA",
        			},
        			{
        				"type":         "datetime",
        				"name":         "TIME",
        				"externalCode": "TIME",
        			},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("biconnector.dataset.add: %w", err)
        }
        
        var item struct {
        	ID b24.ID `json:"id"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("разбор ответа: %w", err)
        }
        fmt.Println(item.ID)
        

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

HTTP-статус: 200

{
            "result": {
              "id": 10
            },
            "time": {
                "start": 1725013197.635808,
                "finish": 1725013198.580873,
                "duration": 0.9450650215148926,
                "processing": 0.6822988986968994,
                "date_start": "2024-08-30T12:19:57+02:00",
                "date_finish": "2024-08-30T12:19:58+02:00",
                "operating": 0
            }
        }
        

Возвращаемые данные

Название
тип

Описание

result
object

Корневой элемент ответа. Содержит поле id с идентификатором созданного датасета

time
time

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

HTTP-статус: 200

{
            "error": "VALIDATION_FIELDS_NOT_PROVIDED",
            "error_description": "Fields not provided."
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

VALIDATION_FIELDS_NOT_PROVIDED

Fields not provided.

Поля не переданы в запросе

VALIDATION_UNKNOWN_PARAMETERS

Unknown parameters: #LIST_OF_PARAMS#

Обнаружены неизвестные параметры: перечень

VALIDATION_REQUIRED_FIELD_MISSING

Field "#TITLE#" is required.

Обязательное поле #TITLE# не передано

VALIDATION_READ_ONLY_FIELD

Field "#TITLE#" is read only.

Поле #TITLE# доступно только для чтения и не может быть изменено

VALIDATION_IMMUTABLE_FIELD

Field "#TITLE#" is immutable.

Поле #TITLE# неизменяемое

VALIDATION_INVALID_FIELD_TYPE

Field "#TITLE#" must be of type #TYPE#.

Поле #TITLE# должно быть типа #TYPE#

SOURCE_NOT_FOUND

Source was not found.

Источник не найден

DATASET_ALREADY_EXIST

Dataset with this name already exists.

Датасет с таким именем уже существует

VALIDATION_DATASET_NAME_INVALID

Dataset name has to start with a lowercase Latin character. Possible entry includes lowercase Latin characters (a-z), numbers (0-9) and underscores.

Неправильный формат названия датасета. Название должно начинаться с буквы, можно использовать только строчные латинские буквы (a-z), цифры и знак _

VALIDATION_DATASET_NAME_TOO_LONG

Dataset name must not exceed 230 characters.

Название датасета не должно превышать 230 символов

VALIDATION_DUPLICATE_FIELD_CODE

Duplicate values found in the "code" parameter: #LIST_CODES#

Обнаружены дубликаты в параметре externalCode полей датасета

VALIDATION_DUPLICATE_FIELD_NAME

Duplicate values found in the "name" parameter: #LIST_NAMES#

Обнаружены дубликаты в параметре name полей датасета

VALIDATION_FIELD_MISSING_REQUIRED_PARAMETERS

Field must include the required parameters: "name", "externalCode" and "type".

Поле должно включать параметры name, externalCode и type

VALIDATION_FIELD_NAME_INVALID_FORMAT

Field "name" has to start with an uppercase Latin character. Possible entry includes uppercase Latin characters (A-Z), numbers (0-9) and underscores.

Неправильный формат названия поля. Название должно начинаться с буквы, можно использовать только заглавные латинские буквы (A-Z), цифры и знак _

VALIDATION_FIELD_NAME_TOO_LONG

Field "name" must not exceed 32 characters.

Название поля не должно превышать 32 символов

VALIDATION_FIELD_INVALID_TYPE

Invalid field type.

Некорректный тип поля

-

Error adding dataset

Ошибка добавления датасета

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

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

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

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

Предыдущая