Создать таблицу biconnector.table.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
biconnectorКто может выполнять метод: пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно
Метод biconnector.table.add создает новую таблицу, связанную с источником данных.
Созданная таблица сразу появляется в BI-Конструкторе, в разделе «Рабочее место аналитика > Таблицы». Метод делает ровно то же, что и создание таблицы вручную в интерфейсе: сохраняет таблицу, ее поля и связь с источником.
Метод не создает датасет для отчетов: датасеты — отдельные объекты BI-Конструктора и через REST API не создаются. Чем таблица отличается от датасета — в разделе Таблица и датасет — разные объекты
Метод работает только в контексте приложения и только с источниками, которые приложение создало само. При вызове вебхуком метод возвращает ошибку ACCESS_DENIED
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Объект, содержащий данные для создания новой таблицы. Формат объекта:
|
Параметр fields
|
Название |
Описание |
|
name* |
Название таблицы. Название должно начинаться с буквы, можно использовать только строчные латинские буквы |
|
externalName* |
Название таблицы во внешнем источнике, в приложении. Максимальная длина 512 символов |
|
externalCode* |
Уникальный код таблицы во внешнем источнике, используется при выборке данных. Максимальная длина 512 символов |
|
sourceId* |
Идентификатор источника, можно получить методами biconnector.source.list или biconnector.source.add. Источник должен принадлежать коннектору текущего приложения, иначе метод вернет |
|
description |
Описание таблицы |
|
fields* |
Массив колонок таблицы (подробное описание) |
Элемент массива fields
Каждый элемент массива fields — объект с тремя обязательными полями. Видимость колонки при создании не задается: все колонки создаются видимыми, скрыть их можно потом методом biconnector.table.fields.update.
|
Название |
Описание |
|
name* |
Название колонки. Название должно начинаться с буквы, можно использовать только заглавные латинские буквы |
|
externalCode* |
Внешний код колонки — имя, под которым колонку знает приложение. Именно его Битрикс24 передает в запросе данных |
|
type* |
Тип данных колонки. Допустимые значения: Значение регистрозависимо: |
Названия колонок и внешние коды не должны повторяться внутри одного запроса: на повтор name метод вернет ошибку DUPLICATE_FIELDS, на повтор externalCode — VALIDATION_DUPLICATE_FIELD_CODE.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"fields": {
"sourceId": 3,
"name": "sales_orders",
"externalName": "Sales orders",
"externalCode": "sales_orders",
"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.table.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
// Methods of this section put errors inside result and answer with HTTP 200
type BiconnectorError = {
error: {
error: string
error_description: string
}
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type TableAddResult = {
id: number
}
try {
const response = await $b24.actions.v2.call.make<TableAddResult | BiconnectorError>({
method: 'biconnector.table.add',
params: {
fields: {
sourceId: 3,
name: 'sales_orders',
externalName: 'Sales orders',
externalCode: 'sales_orders',
description: 'Table 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
// The SDK sees HTTP 200 as success, so check the error inside result yourself
if ('error' in result) {
console.error(result.error.error, result.error.error_description)
} else {
console.info('Created table 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 addTable() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'biconnector.table.add',
params: {
fields: {
sourceId: 3,
name: 'sales_orders',
externalName: 'Sales orders',
externalCode: 'sales_orders',
description: 'Table 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
// The SDK sees HTTP 200 as success, so check the error inside result yourself
if (result && result.error) {
console.error(result.error.error, result.error.error_description)
return
}
console.info('Created table id:', result.id)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addTable)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
# В b24pysdk нет готовой обертки для biconnector.table.*, поэтому метод
# вызывается напрямую через bitrix_token.call_method()
response = bitrix_token.call_method(
api_method="biconnector.table.add",
params={
"fields": {
"sourceId": 3,
"name": "sales_orders",
"externalName": "Sales orders",
"externalCode": "sales_orders",
"description": "Table 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["result"]
# Методы раздела кладут ошибку внутрь result и отвечают со статусом 200
if isinstance(result, dict) and "error" in result:
print(
"Ошибка BIconnector",
f"error: {result['error']['error']}",
f"error_description: {result['error']['error_description']}",
sep="\n",
)
else:
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'biconnector.table.add',
[
'fields' => [
'sourceId' => 3,
'name' => 'sales_orders',
'externalName' => 'Sales orders',
'externalCode' => 'sales_orders',
'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 {
$data = $result->data();
// Методы раздела кладут ошибку внутрь result и отвечают со статусом 200
if (isset($data['error'])) {
echo 'BIconnector error: ' . $data['error']['error'] . ': ' . $data['error']['error_description'];
} else {
echo 'Success: ' . print_r($data, true);
}
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding table: ' . $e->getMessage();
}
BX24.callMethod(
'biconnector.table.add',
{
fields: {
"sourceId": 3,
"name": "sales_orders",
"externalName": "Sales orders",
"externalCode": "sales_orders",
"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) => {
if (result.error()) {
console.error(result.error());
return;
}
const data = result.data();
// Методы раздела кладут ошибку внутрь result и отвечают со статусом 200
if (data && data.error) {
console.error(data.error.error, data.error.error_description);
return;
}
console.info(data);
}
);
require_once('crest.php');
$result = CRest::call(
'biconnector.table.add',
[
'fields' => [
'sourceId' => 3,
'name' => 'sales_orders',
'externalName' => 'Sales orders',
'externalCode' => 'sales_orders',
'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 и отвечают со статусом 200
if (isset($result['result']['error'])) {
echo 'BIconnector error: ' . $result['result']['error']['error']
. ': ' . $result['result']['error']['error_description'];
} else {
echo '<PRE>';
print_r($result);
echo '</PRE>';
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "biconnector.table.add", b24.Params{
"fields": b24.Params{
"sourceId": 3,
"name": "sales_orders",
"externalName": "Sales orders",
"externalCode": "sales_orders",
"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.table.add: %w", err)
}
// Методы раздела кладут ошибку внутрь result и отвечают со статусом 200.
var apiErr struct {
Error *struct {
Error string `json:"error"`
Description string `json:"error_description"`
} `json:"error"`
}
if err := json.Unmarshal(res.Result, &apiErr); err == nil && apiErr.Error != nil {
return fmt.Errorf("biconnector.table.add: %s: %s", apiErr.Error.Error, apiErr.Error.Description)
}
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 |
Корневой элемент ответа (подробное описание) |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
id |
Идентификатор созданной таблицы. Используйте его в методах biconnector.table.get, biconnector.table.update и biconnector.table.fields.update |
Обработка ошибок
HTTP-статус: 200
{
"result": {
"error": {
"error": "VALIDATION_FIELDS_NOT_PROVIDED",
"error_description": "Fields not provided."
}
}
}
Метод возвращает ошибку внутри поля result и с HTTP-статусом 200. Проверяйте result.error: обертки SDK разбирают только верхний уровень ответа и такую ошибку считают успехом
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Access denied. |
Нет одного из двух прав, либо метод вызван вебхуком или вне контекста приложения |
|
|
Fields not provided. |
Поля не переданы в запросе |
|
|
Unknown parameters: #LIST_OF_PARAMS# |
Обнаружены неизвестные параметры: перечень |
|
|
Field "#TITLE#" is required. |
Обязательное поле #TITLE# не передано |
|
|
Field "#TITLE#" is read only. |
Поле #TITLE# доступно только для чтения и не может быть изменено |
|
|
Field "#TITLE#" must be of type #TYPE#. |
Поле #TITLE# должно быть типа #TYPE# |
|
|
Source was not found. |
Источника нет или он принадлежит другому приложению |
|
|
Table with this name already exists. |
Имя занято таблицей, которая уже есть в самом BI-Конструкторе |
|
|
A table named "#NAME#" already exists. |
Название #NAME# уже занято другой таблицей Битрикс24. Имя проверяется по всему Битрикс24, а не в пределах источника |
|
|
$fields is empty |
Передан пустой массив |
|
|
Duplicate column names: #FIELD_NAMES#. |
В параметре |
|
|
Dataset name has to start with a lowercase Latin character. Possible entry includes lowercase Latin characters (a-z), numbers (0-9) and underscores. |
Неправильный формат названия таблицы. Название должно начинаться с буквы, можно использовать только строчные латинские буквы |
|
|
Dataset name must not exceed 230 characters. |
Название таблицы не должно превышать 230 символов |
|
|
Duplicate values found in the "code" parameter: #LIST_CODES# |
Обнаружены дубликаты в параметре |
|
|
Field must include the required parameters: "name", "externalCode" and "type". |
Поле должно включать параметры |
|
|
Field "name" has to start with an uppercase Latin character. Possible entry includes uppercase Latin characters (A-Z), numbers (0-9) and underscores. |
Неправильный формат названия поля. Название должно начинаться с буквы, можно использовать только заглавные латинские буквы |
|
|
Field "name" must not exceed 32 characters. |
Название поля не должно превышать 32 символа |
|
|
Invalid field type. |
Некорректный тип поля |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Таблицы: обзор методов
- Обновить таблицу biconnector.table.update
- Получить таблицу по id biconnector.table.get
- Получить список таблиц biconnector.table.list
- Удалить таблицу biconnector.table.delete
- Обновить колонки таблицы biconnector.table.fields.update
- Получить поля таблицы biconnector.table.fields