Create Dataset biconnector.dataset.add

Scope: biconnector

Who can execute the method: a user with access to the "Analyst's Workspace" section

The method biconnector.dataset.add creates a new dataset associated with 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)

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": "externalName",
                "externalCode": "externalCode",
                "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": "DATE", "externalCode": "DATE" },
                    { "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": "externalName",
                "externalCode": "externalCode",
                "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": "DATE", "externalCode": "DATE" },
                    { "type": "datetime", "name": "TIME", "externalCode": "TIME" }
                ]
            },
            "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/biconnector.dataset.add

try
        {
            const response = await $b24.callMethod(
                'biconnector.dataset.add',
                {
                    fields: {
                        "sourceId": 3,
                        "name": "rest_dataset",
                        "externalName": "externalName",
                        "externalCode": "externalCode",
                        "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": "DATE", "externalCode": "DATE" },
                            { "type": "datetime", "name": "TIME", "externalCode": "TIME" }
                        ]
                    }
                }
            );
            
            const result = response.getData().result;
            result.error()
                ? console.error(result.error())
                : console.info(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'biconnector.dataset.add',
                    [
                        'fields' => [
                            'sourceId'      => 3,
                            'name'          => 'rest_dataset',
                            'externalName'  => 'externalName',
                            'externalCode'  => 'externalCode',
                            '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' => 'DATE', 'externalCode' => 'DATE'],
                                ['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": "externalName",
                    "externalCode": "externalCode",
                    "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": "DATE", "externalCode": "DATE" },
                        { "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' => 'externalName',
                    'externalCode' => 'externalCode',
                    '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' => 'DATE', 'externalCode' => 'DATE' ],
                        [ 'type' => 'datetime', 'name' => 'TIME', 'externalCode' => 'TIME' ]
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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 `integer`	The root element of the response, contains 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 may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

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: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

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