метод REST scope: tasks

tasks.task.chat.message.field.get

Получить поле сообщения чата задачи

Кто может выполнять: любой пользователь

Описание

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

Метод tasks.task.chat.message.field.get возвращает описание поля сообщения чата задачи по имени.

Параметры

name string обязательный

Имя поля, описание которого нужно получить

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":"taskId","select":["name","type","title","description","filterable","sortable","multiple"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/tasks.task.chat.message.field.get

Ответ

HTTP-статус: 200

{
    "result": {
        "item": {
            "name": "taskId",
            "type": "int",
            "title": "taskId",
            "description": null,
            "filterable": false,
            "sortable": false,
            "multiple": false
        }
    },
    "time": {
        "start": 1773649754,
        "finish": 1773649754.213566,
        "duration": 0.21356606483459473,
        "processing": 0,
        "date_start": "2026-03-16T11:29:14+03:00",
        "date_finish": "2026-03-16T11:29:14+03:00",
        "operating_reset_at": 1773650354,
        "operating": 0
    }
}

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

result object

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

item object

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

time time

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

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

HTTP-статус: 400

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

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

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