Получить поля датасета biconnector.dataset.fields
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
biconnectorКто может выполнять метод: пользователь с доступом к разделу «Рабочее место аналитика»
Метод biconnector.dataset.fields возвращает описание полей датасета.
Таблицу с описанием стандартных полей можно найти в статье Датасеты: обзор методов.
Параметры метода
Без параметров.
Примеры кода
Как использовать примеры в документации
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.dataset.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.dataset.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
// Shape of the payload returned in result (match the "response handling" section of the page)
type DatasetFieldsResult = {
fields: {
title: string
type: string
isRequired: boolean
isReadOnly: boolean
isImmutable: boolean
isMultiple: boolean
}[]
}
try {
const response = await $b24.actions.v2.call.make<DatasetFieldsResult>({
method: 'biconnector.dataset.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
console.info('Dataset 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 getDatasetFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'biconnector.dataset.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
console.info('Dataset fields count:', result.fields.length, result.fields)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getDatasetFields)
</script>
try {
$response = $b24Service
->core
->call(
'biconnector.dataset.fields',
[]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error calling biconnector.dataset.fields: ' . $e->getMessage();
}
BX24.callMethod(
'biconnector.dataset.fields',
{},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data());
},
);
require_once('crest.php');
$result = CRest::call(
'biconnector.dataset.fields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "biconnector.dataset.fields", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("biconnector.dataset.fields: %w", err)
}
// Метод заворачивает ответ в объект с ключом "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 |
Корневой элемент ответа. Содержит массив |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |