Получить поля таблицы biconnector.table.fields

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

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

Scope: biconnector

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

Метод biconnector.table.fields возвращает описание полей таблицы.

Назначение каждого поля описано в таблице полей таблицы.

Метод возвращает статическую схему полей таблицы — она одинакова в любом Битрикс24 и не зависит от созданных таблиц. В отличие от остальных методов семейства, метод доступен вебхуку, но оба права проверяет и без них возвращает ошибку ACCESS_DENIED

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

Без параметров.

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.table.fields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/biconnector.table.fields
// 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 TableFieldsResult = {
  fields: {
    title: string
    type: string
    isRequired: boolean
    isReadOnly: boolean
    isImmutable: boolean
    isMultiple: boolean
  }[]
}

try {
  const response = await $b24.actions.v2.call.make<TableFieldsResult | BiconnectorError>({
    method: 'biconnector.table.fields',
    params: {},
    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('Table entity fields count:', result.fields.length, result.fields)
    }
  }
} 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 getTableFields() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'biconnector.table.fields',
        params: {},
        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('Table entity fields count:', result.fields.length, result.fields)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

try:
    # В b24pysdk нет готовой обертки для biconnector.table.*, поэтому метод
    # вызывается напрямую через bitrix_token.call_method()
    response = bitrix_token.call_method(
        api_method="biconnector.table.fields",
    )
    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.fields',
            []
        );

    $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 calling biconnector.table.fields: ' . $e->getMessage();
}
BX24.callMethod(
    'biconnector.table.fields',
    {},
    (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.fields',
    []
);

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

// Метод заворачивает ответ в объект с ключом "fields".
raw, ok := b24.Unwrap(res.Result, "fields")
if !ok {
	return fmt.Errorf("в ответе нет ключа fields")
}

var items []struct {
	Title       string `json:"title"`
	Type        string `json:"type"`
	IsRequired  bool   `json:"isRequired"`
	IsReadOnly  bool   `json:"isReadOnly"`
	IsImmutable bool   `json:"isImmutable"`
	IsMultiple  bool   `json:"isMultiple"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.Title)
}

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

HTTP-статус: 200

{
  "result": {
    "fields": [
      {
        "title": "id",
        "type": "integer",
        "isRequired": true,
        "isReadOnly": true,
        "isImmutable": false,
        "isMultiple": false
      },
      {
        "title": "sourceId",
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": true,
        "isMultiple": false
      },
      {
        "title": "name",
        "type": "string",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": true,
        "isMultiple": false
      },
      {
        "title": "type",
        "type": "string",
        "isRequired": true,
        "isReadOnly": true,
        "isImmutable": false,
        "isMultiple": false
      },
      {
        "title": "description",
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false
      },
      {
        "title": "externalName",
        "type": "string",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": true,
        "isMultiple": false
      },
      {
        "title": "externalCode",
        "type": "string",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": true,
        "isMultiple": false
      },
      {
        "title": "externalId",
        "type": "integer",
        "isRequired": true,
        "isReadOnly": true,
        "isImmutable": false,
        "isMultiple": false
      },
      {
        "title": "dateCreate",
        "type": "datetime",
        "isRequired": true,
        "isReadOnly": true,
        "isImmutable": false,
        "isMultiple": false
      },
      {
        "title": "dateUpdate",
        "type": "datetime",
        "isRequired": true,
        "isReadOnly": true,
        "isImmutable": false,
        "isMultiple": false
      },
      {
        "title": "createdById",
        "type": "integer",
        "isRequired": true,
        "isReadOnly": true,
        "isImmutable": false,
        "isMultiple": false
      },
      {
        "title": "updatedById",
        "type": "integer",
        "isRequired": true,
        "isReadOnly": true,
        "isImmutable": false,
        "isMultiple": false
      },
      {
        "title": "fields",
        "type": "array",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": true
      }
    ]
  },
  "time": {
    "start": 1740757652.264398,
    "finish": 1740757652.343882,
    "duration": 0.0794839859008789,
    "processing": 2.002716064453125e-5,
    "date_start": "2025-02-28T15:47:32+00:00",
    "date_finish": "2025-02-28T15:47:32+00:00"
  }
}

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

Название
тип

Описание

result
object

Корневой элемент ответа. Содержит единственный ключ fields

result.fields
object[]

Массив дескрипторов полей таблицы, один элемент — одно поле (подробное описание)

time
time

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

Элемент массива fields

Название
тип

Описание

title
string

Название поля таблицы. Назначение полей — в таблице полей таблицы

type
string

Тип поля. Метод возвращает значения integer, string, array и datetime

isRequired
boolean

Признак обязательности поля в схеме объекта. Передавать при создании нужно только те поля, у которых isRequired равно true, а isReadOnlyfalse: у полей только для чтения признак тоже равен true, но передать их нельзя

isReadOnly
boolean

Поле доступно только для чтения, передать его в add или update нельзя

isImmutable
boolean

Значение задается один раз при создании таблицы и потом не меняется

isMultiple
boolean

Множественное поле. Если равно true, значение передается массивом

Схема описывает поля самой таблицы, а не колонки данных. Она не полностью совпадает с таблицей полей: параметров разбора CSV — csvDelimiter, csvEncoding и csvHasHeaders — в схеме нет, хотя в ответах get и list они приходят. Именно по этой схеме проверяются select, filter и order метода biconnector.table.list. Состав колонок возвращает метод biconnector.table.get, а меняет — biconnector.table.fields.update.

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

HTTP-статус: 200

{
    "result": {
        "error": {
            "error": "ACCESS_DENIED",
            "error_description": "Access denied."
        }
    }
}

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

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Значение

ACCESS_DENIED

Access denied.

Нет одного из двух прав

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

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

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

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