Create Dataset biconnector.dataset.add

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: biconnector

Who can execute the method: a user with access to the Analytics hub section

The biconnector.dataset.add method creates a new dataset linked to a data source.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

An object containing data to create a new dataset. The object format is:

{
            "field_1": "value_1",
            "field_2": "value_2",
            ...,
            "field_n": "value_n"
        }

field_n — field name
value_n — field value

Detailed description below

Parameter fields

Name `type`	Description
name* `string`	The name of the dataset. The name must start with a letter and can only use lowercase Latin letters `a-z`, numbers, and the underscore `_`. The maximum length of the name is 230 characters
externalName* `string`	The name of the dataset in the external source, in the application
externalCode* `string`	A unique code for the dataset in the external source, used when retrieving data
sourceId* `integer`	The identifier of the source, which can be obtained using the methods biconnector.source.list or biconnector.source.add
description `string`	Description of the dataset
fields* `array`	A list of dataset fields, (Detailed description)

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "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" }
                ]
            }
        }' \
        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": "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" }
                ]
            },
            "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>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.biconnector.dataset.add(
                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",
                        },
                    ],
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

try {
            $response = $b24Service
                ->core
                ->call(
                    'biconnector.dataset.add',
                    [
                        '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'],
                            ],
                        ],
                    ]
                );
        
            $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": "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" }
                    ]
                }
            },
            (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' => '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' ]
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "biconnector.dataset.add", b24.Params{
        	"fields": b24.Params{
        		"sourceId":     3,
        		"name":         "rest_dataset",
        		"externalName": "extranalName",
        		"externalCode": "extrnalCode",
        		"description":  "Dataset 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("parse response: %w", err)
        }
        fmt.Println(item.ID)

Response Handling

HTTP status: 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
            }
        }

Returned Data

Name `type`	Description
result `object`	Response root element. Contains the `id` field with the identifier of the created dataset
time `time`	Information about the request execution time

HTTP status: 200

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

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code	Description	Value
`VALIDATION_FIELDS_NOT_PROVIDED`	Fields not provided.	Fields were not passed in the request
`VALIDATION_UNKNOWN_PARAMETERS`	Unknown parameters: #LIST_OF_PARAMS#	Unknown parameters detected: list
`VALIDATION_REQUIRED_FIELD_MISSING`	Field "#TITLE#" is required.	Required field #TITLE# was not provided
`VALIDATION_READ_ONLY_FIELD`	Field "#TITLE#" is read only.	Field #TITLE# is read-only and cannot be modified
`VALIDATION_IMMUTABLE_FIELD`	Field "#TITLE#" is immutable.	Field #TITLE# is immutable
`VALIDATION_INVALID_FIELD_TYPE`	Field "#TITLE#" must be of type #TYPE#.	Field #TITLE# must be of type #TYPE#
`SOURCE_NOT_FOUND`	Source was not found.	Source not found
`DATASET_ALREADY_EXIST`	Dataset with this name already exists.	A 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.	Incorrect dataset name format. The name must start with a letter and can only use lowercase Latin letters `(a-z)`, numbers, and the underscore `_`
`VALIDATION_DATASET_NAME_TOO_LONG`	Dataset name must not exceed 230 characters.	Dataset name must not exceed 230 characters
`VALIDATION_DUPLICATE_FIELD_CODE`	Duplicate values found in the "code" parameter: #LIST_CODES#	Duplicates found in the `externalCode` parameter of dataset fields
`VALIDATION_DUPLICATE_FIELD_NAME`	Duplicate values found in the "name" parameter: #LIST_NAMES#	Duplicates found in the `name` parameter of dataset fields
`VALIDATION_FIELD_MISSING_REQUIRED_PARAMETERS`	Field must include the required parameters: "name", "externalCode" and "type".	Field must include the parameters `name`, `externalCode`, and `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.	Incorrect field name format. The name must start with a letter and can only use uppercase Latin letters `(A-Z)`, numbers, and the underscore `_`
`VALIDATION_FIELD_NAME_TOO_LONG`	Field "name" must not exceed 32 characters.	Field name must not exceed 32 characters
`VALIDATION_FIELD_INVALID_TYPE`	Invalid field type.	Invalid field type
`-`	`Error adding dataset`	Error adding dataset

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Was the article helpful?

Overview of methods

Update dataset

Create Dataset biconnector.dataset.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning