# note.document.search.field.get

URL: https://chugunov.pro/api-bitrix24/note/document/note-document-search-field-get/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить поле поиска документов
Scope: `note`
Кто может выполнять метод: пользователь с доступом к модулю База знаний

## Описание

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](https://chugunov.pro/api-bitrix24/rest-v3/).

Метод `note.document.search.field.get` возвращает описание поля результата поиска документов по имени.

## Параметры

- `name` `string` — обязательный. Имя поля, описание которого нужно получить.
  Доступные поля:
  - `documentId` — идентификатор найденного документа
  - `collectionId` — идентификатор базы знаний
  - `title` — заголовок документа
  - `score` — относительная релевантность совпадения
  - `snippet` — фрагмент текста с выделением совпадений
  - `sharedAccess` — признак прямого доступа к документу
- `select` `array` — необязательный. Список полей описания, которые нужно вернуть в ответе.
  Доступные поля:
  - `name` — имя поля
  - `type` — тип данных
  - `title` — заголовок
  - `description` — описание
  - `validationRules` — правила валидации
  - `requiredGroups` — группы обязательности
  - `filterable` — признак доступности в фильтре
  - `sortable` — признак доступности в сортировке
  - `editable` — признак редактируемости
  - `multiple` — признак множественного значения
  - `elementType` — тип элемента для составных полей

## Ответ

HTTP-статус: 200

```json
{
    "result": {
        "item": {
            "name": "snippet",
            "type": "string",
            "title": "snippet"
        }
    },
    "time": {
        "start": 1780803300,
        "finish": 1780803300.082441,
        "duration": 0.08244109153747559,
        "processing": 0,
        "date_start": "2026-06-22T09:35:00+03:00",
        "date_finish": "2026-06-22T09:35:00+03:00",
        "operating_reset_at": 1780803900,
        "operating": 0
    }
}
```

### Возвращаемые данные

- `result` `object`. Объект с данными ответа
- `item` `object`. Объект с описанием поля. Структура ответа зависит от `select`
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Обязательное поле `name` не указано",
                "field": "name"
            }
        ]
    }
}
```

- `Поле` — **Описание ошибки**. **Как исправить**
- — — Доступ запрещен. Проверьте права пользователя и scope `note`

## Примеры запроса

### cURL (Webhook)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"snippet","select":["name","type","title"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.document.search.field.get
```

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"snippet","select":["name","type","title"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.document.search.field.get
```

### JS (TS)

```ts
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type SearchFieldGetResult = {
  item: {
    name?: string
    type?: string
    title?: string
  }
}

try {
  const response = await $b24.actions.v3.call.make<SearchFieldGetResult>({
    method: 'note.document.search.field.get',
    params: {
      name: 'snippet',
      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)
}
```

### JS (UMD)

```html
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getSearchField() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'note.document.search.field.get',
        params: {
          name: 'snippet',
          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', getSearchField)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

select = [
    "name",
    "type",
    "title",
]

try:
    bitrix_response = client.note.document.search.field.get(
        name='snippet',
        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}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'note.document.search.field.get',
            [
                'name' => 'snippet',
                '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.js

```js
BX24.callMethod(
    'note.document.search.field.get',
    {
        name: 'snippet',
        select: [
            'name',
            'type',
            'title'
        ]
    },
    function(result){
        console.info(result.data());
        console.log(result);
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'note.document.search.field.get',
    [
        'name' => 'snippet',
        'select' => [
            'name',
            'type',
            'title'
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "note.document.search.field.get", b24.Params{
	"name":   "snippet",
	"select": []string{"name", "type", "title"},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("note.document.search.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)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/note/document/note-document-search-field-get.html