note.document.search.field.list
Получить список полей поиска документов
Описание
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод note.document.search.field.list возвращает список доступных полей результата поиска документов.
Параметры
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 '{"select":["name","type","title","filterable","sortable"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.document.search.field.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["name","type","title","filterable","sortable"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.document.search.field.list
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type SearchFieldItem = {
name: string
type: string
title: string
filterable: boolean
sortable: boolean
}
type SearchFieldListResult = {
items: SearchFieldItem[]
}
try {
const response = await $b24.actions.v3.call.make<SearchFieldListResult>({
method: 'note.document.search.field.list',
params: {
select: [
'name',
'type',
'title',
'filterable',
'sortable',
],
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Search fields:', result.items)
}
} catch (error) {
console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function listSearchFields() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'note.document.search.field.list',
params: {
select: [
'name',
'type',
'title',
'filterable',
'sortable',
],
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Search fields:', result.items)
} catch (error) {
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listSearchFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
select = [
"name",
"type",
"title",
"filterable",
"sortable",
]
try:
bitrix_response = client.note.document.search.field.list(
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.search.field.list',
[
'select' => [
'name',
'type',
'title',
'filterable',
'sortable'
]
]
);
$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.search.field.list',
{
select: [
'name',
'type',
'title',
'filterable',
'sortable'
]
},
function(result){
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'note.document.search.field.list',
[
'select' => [
'name',
'type',
'title',
'filterable',
'sortable'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "note.document.search.field.list", b24.Params{
"select": []string{"name", "type", "title", "filterable", "sortable"},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("note.document.search.field.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "items".
raw, ok := b24.Unwrap(res.Result, "items")
if !ok {
return fmt.Errorf("в ответе нет ключа items")
}
var items []struct {
Name string `json:"name"`
Type string `json:"type"`
Title string `json:"title"`
Filterable bool `json:"filterable"`
Sortable bool `json:"sortable"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.Name)
}
Ответ
HTTP-статус: 200
{
"result": {
"items": [
{
"name": "documentId",
"type": "int",
"title": "documentId",
"filterable": false,
"sortable": false
},
{
"name": "collectionId",
"type": "int",
"title": "collectionId",
"filterable": false,
"sortable": false
},
{
"name": "title",
"type": "string",
"title": "title",
"filterable": false,
"sortable": false
},
{
"name": "score",
"type": "float",
"title": "score",
"filterable": false,
"sortable": false
},
{
"name": "snippet",
"type": "string",
"title": "snippet",
"filterable": false,
"sortable": false
},
{
"name": "sharedAccess",
"type": "bool",
"title": "sharedAccess",
"filterable": false,
"sortable": false
}
]
},
"time": {
"start": 1780803000,
"finish": 1780803000.108772,
"duration": 0.10877203941345215,
"processing": 0,
"date_start": "2026-06-22T09:30:00+03:00",
"date_finish": "2026-06-22T09:30:00+03:00",
"operating_reset_at": 1780803600,
"operating": 0
}
}
Возвращаемые данные
result
object
Объект с данными ответа
items
array
Массив объектов с описанием полей. Структура ответа зависит от select
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION",
"message": "Неизвестное поле `unknownField` для сущности `DtoFieldDto`"
}
}
| Код | Описание | Значение |
|---|---|---|
Поле |
Описание ошибки | Как исправить |
| — | Доступ запрещен | Проверьте права пользователя и scope note |

