Обновить датасет biconnector.dataset.update

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

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

Scope: biconnector

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

DEPRECATED

Развитие метода остановлено. Используйте biconnector.table.update.

Метод biconnector.dataset.update обновляет понятное пользователю название, описание и группы существующего датасета.

Метод работает только в контексте приложения и изменяет только те датасеты, которые приложение создало само. При вызове вебхуком метод возвращает ошибку ACCESS_DENIED

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

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

Название
тип

Описание

id*
integer

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

fields*
object

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

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

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

Параметр fields

Название
тип

Описание

verboseName
string

Понятное пользователю название датасета, например Заказы. Максимальная длина 255 символов

description
string

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

tableGroupIds
array

Массив идентификаторов групп таблиц. Таблица датасета окажется ровно в этих группах. Каждый идентификатор — положительное целое число, группа должна существовать.

Если параметр не передан или передан пустой массив, группы не меняются.

Получить список групп таблиц через REST API нельзя. Методы biconnector.dataset.get и biconnector.dataset.list группы не возвращают

Чтобы изменить состав полей, используйте метод biconnector.dataset.fields.update.

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "id": 10,
    "fields": {
        "description": "Новое описание"
    },
    "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/biconnector.dataset.update
// 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
  }
}

try {
  const response = await $b24.actions.v2.call.make<boolean | BiconnectorError>({
    method: 'biconnector.dataset.update',
    params: {
      id: 10,
      fields: {
        description: 'New description',
      },
    },
    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 (typeof result === 'object' && result !== null && 'error' in result) {
      console.error(result.error.error, result.error.error_description)
    } else {
      console.info('Dataset updated:', result)
    }
  }
} 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 updateDataset() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'biconnector.dataset.update',
        params: {
          id: 10,
          fields: {
            description: 'New description',
          },
        },
        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('Dataset updated:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updateDataset)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.biconnector.dataset.update(
        bitrix_id=10,
        fields={
            "description": "New description",
        },
    ).response
    result = bitrix_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.dataset.update',
            [
                'id' => 10,
                'fields' => [
                    "description" => "Новое описание",
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($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 updating dataset: ' . $e->getMessage();
}
BX24.callMethod(
    'biconnector.dataset.update',
    {
        id: 10,
        fields: {
            "description": "Новое описание",
        }
    },
    (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.dataset.update',
    [
        'id' => 10,
        'fields' => [
            'description' => 'Новое описание'
        ]
    ]
);

// Методы раздела кладут ошибку внутрь 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.dataset.update", b24.Params{
	"id": 10,
	"fields": b24.Params{
		"description": "Новое описание",
	},
})
if err != nil {
	return fmt.Errorf("biconnector.dataset.update: %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.dataset.update: %s: %s", apiErr.Error.Error, apiErr.Error.Description)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)

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

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1725365418.056843,
        "finish": 1725365419.671506,
        "duration": 1.6146628856658936,
        "processing": 1.3475170135498047,
        "date_start": "2024-09-03T14:10:18+02:00",
        "date_finish": "2024-09-03T14:10:19+02:00"
    }
}

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

Название
тип

Описание

result
boolean

Корневой элемент ответа. При успешном обновлении содержит true — объекта с данными датасета в ответе нет. Чтобы увидеть новые значения полей, вызовите biconnector.dataset.get

time
time

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

Обработка ошибок

HTTP-статус: 200

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

Метод возвращает ошибку внутри поля result и с HTTP-статусом 200. Проверяйте result.error: обертки SDK разбирают только верхний уровень ответа и такую ошибку считают успехом

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Значение

ACCESS_DENIED

Access denied.

Нет одного из двух прав, на Битрикс24 недоступны внешние источники данных BI Конструктора, либо метод вызван вебхуком или вне контекста приложения

VALIDATION_ID_NOT_PROVIDED

ID is missing.

Идентификатор не указан

VALIDATION_INVALID_ID_FORMAT

ID has to be a positive integer.

Неверный формат ID

VALIDATION_FIELDS_NOT_PROVIDED

Fields not provided.

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

VALIDATION_UNKNOWN_PARAMETERS

Unknown parameters: #LIST_OF_PARAMS#

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

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#

VALIDATION_INVALID_FIELD_TYPE

Field "tableGroupIds" must be an array of positive integers.

В массиве tableGroupIds есть значение, которое не является положительным целым числом

VALIDATION_TABLE_GROUP_NOT_FOUND

Table group was not found.

Группы таблиц с одним из идентификаторов из tableGroupIds нет

BX_INVALID_VALUE

The length of "VERBOSE_NAME" should not exceed 255 characters.

Значение verboseName длиннее 255 символов

DATASET_NOT_FOUND

Dataset was not found.

Датасета нет или он принадлежит другому приложению

INVALID_METHOD

Use the method "biconnector.dataset.fields.update" to update the dataset fields."

В параметре fields передан ключ fields. Для обновления полей используйте метод biconnector.dataset.fields.update. Лишняя кавычка в конце — часть текста, который возвращает модуль

Пустое значение

Error updating table.

Обновление отклонил обработчик, подписанный на событие до сохранения. Собственного строкового кода у этой ошибки нет: в поле error приходит числовой ноль

Синхронизация с BI-Конструктором идет после сохранения, и на ответ она не влияет: если синхронизация не удалась, метод все равно вернет true. Этим update отличается от biconnector.dataset.fields.update, где сбой синхронизации приходит в ответе кодом DATASET_UPDATE_ERROR

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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