метод REST scope: note

note.collection.field.list

Получить список полей базы знаний

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

Описание

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод note.collection.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.collection.field.list

Ответ

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "name": "id",
                "type": "int",
                "title": "id",
                "filterable": false,
                "sortable": false
            },
            {
                "name": "name",
                "type": "string",
                "title": "name",
                "filterable": false,
                "sortable": false
            },
            {
                "name": "position",
                "type": "int",
                "title": "position",
                "filterable": false,
                "sortable": false
            },
            {
                "name": "policyLevel",
                "type": "string",
                "title": "policyLevel",
                "filterable": false,
                "sortable": false
            },
            {
                "name": "createdBy",
                "type": "int",
                "title": "createdBy",
                "filterable": false,
                "sortable": false
            },
            {
                "name": "createdAt",
                "type": "string",
                "title": "createdAt",
                "filterable": false,
                "sortable": false
            },
            {
                "name": "updatedBy",
                "type": "int",
                "title": "updatedBy",
                "filterable": false,
                "sortable": false
            },
            {
                "name": "updatedAt",
                "type": "string",
                "title": "updatedAt",
                "filterable": false,
                "sortable": false
            }
        ]
    },
    "time": {
        "start": 1780801200,
        "finish": 1780801200.105441,
        "duration": 0.10544109344482422,
        "processing": 0,
        "date_start": "2026-06-22T09:00:00+03:00",
        "date_finish": "2026-06-22T09:00:00+03:00",
        "operating_reset_at": 1780801800,
        "operating": 0
    }
}

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

result object

Объект с данными ответа

items array

Массив объектов с описанием полей. Структура ответа зависит от select

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION",
        "message": "Неизвестное поле `unknownField` для сущности `DtoFieldDto`"
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
Доступ запрещен Проверьте права пользователя и scope note

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.