Для AI-агентов: markdown этой страницы — /docs-content/entities/task-comments/fields.md индекс документации — /llms.txt

Поля комментария

GET /v1/tasks/:taskId/comments/fields

Возвращает схему полей комментария задачи: для каждого из шести полей — тип, признак «только для чтения», отображаемое название и описание. Помогает автогенерации кода и подсказкам AI-агентам.

Параметры

Параметр Тип Обяз. Описание
taskId (path) number да ID задачи. Значение не проверяется — схема одинакова для любого, включая несуществующую задачу

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/tasks/289/comments/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/tasks/289/comments/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/tasks/289/comments/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Поля комментария:', Object.keys(data.fields))

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/tasks/289/comments/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Поля ответа

data.fields — объект, ключ которого — имя поля, а значение — { type, readonly, label, description }.

Подписи полей label и description приходят на русском языке. Заголовками запроса язык не переключается.

Поле Тип RO Описание
id number да Идентификатор комментария. Может прийти null в ответе создания на новой карточке
taskId number да Идентификатор родительской задачи. Берётся из пути URL
authorId number да Автор комментария. Список сотрудников: GET /v1/users
message string Текст комментария, до 65 535 символов. Единственное записываемое поле, обязателен при создании. Поддерживает BB-код
createdAt datetime да Дата и время создания, UTC ISO 8601
attachments array да Файлы, приложенные к комментарию. Ключ присутствует всегда, без файлов — пустой список. Элемент: fileId (число), name и size (когда Битрикс24 их отдал), downloadUrl (путь к байтам без домена)

Поля с отметкой RO (readonly: true) заполняются платформой и не принимаются при создании и обновлении. Записывается только message.

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true, "label": "Идентификатор", "description": "Идентификатор комментария.", "nullable": true },
      "taskId": { "type": "number", "readonly": true, "label": "Идентификатор задачи", "description": "Идентификатор родительской задачи (из пути запроса)." },
      "authorId": { "type": "number", "readonly": true, "label": "Идентификатор автора", "description": "Идентификатор пользователя, оставившего комментарий, — из GET /v1/users." },
      "message": { "type": "string", "readonly": false, "label": "Текст", "description": "Текст комментария. Обязателен при создании." },
      "createdAt": { "type": "datetime", "readonly": true, "label": "Дата создания", "description": "Дата создания, UTC ISO 8601." },
      "attachments": { "type": "array", "readonly": true, "label": "Вложения", "description": "Файлы, приложенные к комментарию. Ключ присутствует всегда; без файлов — пустой массив. Элемент: fileId (число), name (строка, когда Б24 его отдал), size (размер в байтах, когда Б24 его отдал), downloadUrl (строка, путь без домена — склейте с базовым URL API вашего портала)." }
    }
  }
}

Пример ответа при ошибке

403 — у ключа нет скоупа task:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'task' scope"
  }
}

Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа task
401 MISSING_API_KEY Заголовок X-Api-Key не передан

Полный список общих ошибок API — Ошибки.

Смотрите также