метод REST
scope: biconnector
biconnector.source.fields
Получить поля источника
Описание
Метод biconnector.source.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.source.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.source.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
type FieldDescription = {
title: string
type: string
isRequired: boolean
isReadOnly: boolean
isImmutable: boolean
isMultiple: boolean
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type SourceFieldsResult = {
fields: FieldDescription[]
}
try {
const response = await $b24.actions.v2.call.make<SourceFieldsResult>({
method: 'biconnector.source.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('Source fields:', 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 getSourceFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'biconnector.source.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('Source fields:', result.fields)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getSourceFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.biconnector.source.fields().response
result = bitrix_response.result
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.source.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 fetching source fields: ' . $e->getMessage();
}
BX24.callMethod(
'biconnector.source.fields',
{},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data());
},
);
require_once('crest.php');
$result = CRest::call(
'biconnector.source.fields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "biconnector.source.fields", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("biconnector.source.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": "title",
"type": "string",
"isRequired": true,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false
},
{
"title": "type",
"type": "string",
"isRequired": true,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false
},
{
"title": "code",
"type": "string",
"isRequired": true,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false
},
{
"title": "description",
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false
},
{
"title": "active",
"type": "boolean",
"isRequired": false,
"isReadOnly": false,
"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": "connectorId",
"type": "integer",
"isRequired": true,
"isReadOnly": false,
"isImmutable": true,
"isMultiple": false
},
{
"title": "settings",
"type": "array",
"isRequired": true,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": true
}
]
},
"time": {
"start": 1742896156.448294,
"finish": 1742896156.503291,
"duration": 0.05499696731567383,
"processing": 0.0004570484161376953,
"date_start": "2025-03-25T09:49:16+00:00",
"date_finish": "2025-03-25T09:49:16+00:00"
}
}

