Получить датасет по id biconnector.dataset.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
biconnectorКто может выполнять метод: пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно
DEPRECATED
Развитие метода остановлено. Используйте biconnector.table.get.
Метод biconnector.dataset.get возвращает информацию о датасете по идентификатору.
Метод работает только в контексте приложения и возвращает только те датасеты, которые приложение создало само. При вызове вебхуком метод возвращает ошибку ACCESS_DENIED
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор датасета, можно получить методами biconnector.dataset.list и biconnector.dataset.add |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":2,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/biconnector.dataset.get
// 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 DatasetGetResult = {
item: {
id: number
type: string
name: string
description: string
externalCode: string
externalName: string
dateCreate: string
dateUpdate: string
createdById: number
updatedById: number
externalId: number
csvDelimiter: string
csvEncoding: string
csvHasHeaders: boolean
fields: Array<{
id: number
datasetId: number
type: string
name: string
externalCode: string
visible: boolean
description: string
}>
}
}
try {
const response = await $b24.actions.v2.call.make<DatasetGetResult | BiconnectorError>({
method: 'biconnector.dataset.get',
params: {
id: 2,
},
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(result.item.id, result.item.name, result.item.type)
}
}
} 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 getDataset() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'biconnector.dataset.get',
params: {
id: 2,
},
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(result.item.id, result.item.name, result.item.type)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getDataset)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.biconnector.dataset.get(
bitrix_id=2,
).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.get',
[
'id' => 2,
]
);
$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 'Data: ' . print_r($data, true);
}
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting dataset: ' . $e->getMessage();
}
BX24.callMethod(
'biconnector.dataset.get',
{
id: 2,
},
(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.get',
[
'id' => 2
]
);
// Методы раздела кладут ошибку внутрь 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.get", b24.Params{
"id": 2,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("biconnector.dataset.get: %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.get: %s: %s", apiErr.Error.Error, apiErr.Error.Description)
}
// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("в ответе нет ключа item")
}
var item struct {
ID b24.ID `json:"id"`
Type string `json:"type"`
Name string `json:"name"`
Description string `json:"description"`
ExternalCode string `json:"externalCode"`
ExternalName string `json:"externalName"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Type)
Обработка ответа
HTTP-статус: 200
{
"result": {
"item": {
"id": 2,
"type": "rest",
"name": "rest_dataset11111",
"description": "new__2_",
"externalCode": "sales_orders",
"externalName": "Sales orders",
"dateCreate": "2025-03-26 15:28:06",
"dateUpdate": "2025-03-27 07:47:43",
"createdById": 1,
"updatedById": 1,
"externalId": 275,
"csvDelimiter": "",
"csvEncoding": "",
"csvHasHeaders": false,
"fields": [
{"id": 224, "datasetId": 2, "type": "int", "name": "ID", "externalCode": "ID", "visible": true, "description": ""},
{"id": 225, "datasetId": 2, "type": "string", "name": "NAME", "externalCode": "NAME", "visible": true, "description": ""},
{"id": 226, "datasetId": 2, "type": "string", "name": "SURNAME", "externalCode": "SURNAME", "visible": true, "description": ""},
{"id": 227, "datasetId": 2, "type": "double", "name": "SCORE", "externalCode": "SCORE", "visible": true, "description": ""},
{"id": 228, "datasetId": 2, "type": "date", "name": "DATA", "externalCode": "DATA", "visible": true, "description": ""},
{"id": 229, "datasetId": 2, "type": "datetime", "name": "TIME", "externalCode": "TIME", "visible": true, "description": ""}
]
}
},
"time": {
"start": 1743061675.963969,
"finish": 1743061676.064591,
"duration": 0.10062193870544434,
"processing": 0.011152029037475586,
"date_start": "2025-03-27T07:47:55+00:00",
"date_finish": "2025-03-27T07:47:56+00:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Содержит единственный ключ |
|
time |
Информация о времени выполнения запроса |
Поля sourceId в ответе нет — идентификатор источника возвращает только метод biconnector.dataset.list. Состав полей датасета, наоборот, доступен только через get: в выборке list массива fields не будет.
Обработка ошибок
HTTP-статус: 200
{
"result": {
"error": {
"error": "VALIDATION_ID_NOT_PROVIDED",
"error_description": "ID is missing."
}
}
}
Метод возвращает ошибку внутри поля result и с HTTP-статусом 200. Проверяйте result.error: обертки SDK разбирают только верхний уровень ответа и такую ошибку считают успехом
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Access denied. |
Нет одного из двух прав, либо метод вызван вебхуком или вне контекста приложения |
|
|
ID is missing. |
Идентификатор не указан |
|
|
ID has to be a positive integer. |
Неверный формат ID |
|
|
Dataset was not found. |
Датасета нет или он принадлежит другому приложению |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Устаревшие методы biconnector.dataset.*: обзор методов
- Создать датасет biconnector.dataset.add
- Обновить датасет biconnector.dataset.update
- Получить список датасетов biconnector.dataset.list
- Удалить датасет biconnector.dataset.delete
- Обновить поля датасета biconnector.dataset.fields.update
- Получить поля датасета biconnector.dataset.fields