note.document.tree.field.get
Получить поле дерева документов
Описание
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод note.document.tree.field.get возвращает описание поля дерева документов по имени.
Параметры
name
string
обязательный
Имя поля, описание которого нужно получить.
Доступные поля:
id— идентификатор документаcollectionId— идентификатор базы знанийparentId— идентификатор родительского документаtitle— заголовок документаposition— позиция документа среди соседних страницchildren— дочерние страницы документа
select
array
необязательный
Список полей описания, которые нужно вернуть в ответе.
Доступные поля:
name— имя поляtype— тип данныхtitle— заголовокdescription— описаниеvalidationRules— правила валидацииrequiredGroups— группы обязательностиfilterable— признак доступности в фильтреsortable— признак доступности в сортировкеeditable— признак редактируемостиmultiple— признак множественного значенияelementType— тип элемента для составных полей
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"children","select":["name","type","title"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.document.tree.field.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"children","select":["name","type","title"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.document.tree.field.get
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type TreeFieldGetResult = {
item: {
name?: string
type?: string
title?: string
}
}
try {
const response = await $b24.actions.v3.call.make<TreeFieldGetResult>({
method: 'note.document.tree.field.get',
params: {
name: 'children',
select: [
'name',
'type',
'title',
],
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Field description:', result.item)
}
} catch (error) {
console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getTreeField() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'note.document.tree.field.get',
params: {
name: 'children',
select: [
'name',
'type',
'title',
],
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Field description:', result.item)
} catch (error) {
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getTreeField)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
select = [
"name",
"type",
"title",
]
try:
bitrix_response = client.note.document.tree.field.get(
name='children',
select=select,
).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(
'note.document.tree.field.get',
[
'name' => 'children',
'select' => [
'name',
'type',
'title'
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'note.document.tree.field.get',
{
name: 'children',
select: [
'name',
'type',
'title'
]
},
function(result){
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'note.document.tree.field.get',
[
'name' => 'children',
'select' => [
'name',
'type',
'title'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "note.document.tree.field.get", b24.Params{
"name": "children",
"select": []string{"name", "type", "title"},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("note.document.tree.field.get: %w", err)
}
// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("в ответе нет ключа item")
}
var item struct {
Name string `json:"name"`
Type string `json:"type"`
Title string `json:"title"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Name, item.Type)
Ответ
HTTP-статус: 200
{
"result": {
"item": {
"name": "children",
"type": "array",
"title": "children"
}
},
"time": {
"start": 1780802700,
"finish": 1780802700.081221,
"duration": 0.08122110366821289,
"processing": 0,
"date_start": "2026-06-22T09:25:00+03:00",
"date_finish": "2026-06-22T09:25:00+03:00",
"operating_reset_at": 1780803300,
"operating": 0
}
}
Возвращаемые данные
result
object
Объект с данными ответа
item
object
Объект с описанием поля. Структура ответа зависит от select
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Ошибка при валидации объекта запроса",
"validation": [
{
"message": "Обязательное поле `name` не указано",
"field": "name"
}
]
}
}
| Код | Описание | Значение |
|---|---|---|
Поле |
Описание ошибки | Как исправить |
| — | Доступ запрещен | Проверьте права пользователя и scope note |

