Учёт времени задач

Записи о потраченном на задачу времени — вложенный ресурс задачи. У каждой записи есть длительность, автор, комментарий и время создания. Базовый путь — /v1/tasks/:taskId/time. Все операции требуют существующей задачи (:taskId) на портале.

Битрикс24 API: task.elapseditem.* Скоуп: task

Добавить запись учёта времени

POST /v1/tasks/:taskId/time

Создаёт новую запись учёта времени для задачи. Обязательное поле — seconds; комментарий и автор передаются опционально.

Параметры

Параметр Тип Обяз. Описание
taskId (path) number да ID задачи

Поля запроса (body)

Поле Тип Обяз. Описание
seconds number Длительность в секундах
comment string Комментарий к записи. Записывается в COMMENT_TEXT
userId number ID автора. По умолчанию — пользователь API-ключа. Передавайте только существующие ID сотрудников (GET /v1/users) — см. «Известные особенности».

Примеры

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

Terminal
curl -X POST "https://vibecode.bitrix24.tech/v1/tasks/289/time" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "seconds": 1800,
    "comment": "Подготовка черновика"
  }'

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

Terminal
curl -X POST "https://vibecode.bitrix24.tech/v1/tasks/289/time" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "seconds": 1800,
    "comment": "Подготовка черновика"
  }'

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/tasks/289/time', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    seconds: 1800,
    comment: 'Подготовка черновика',
  }),
})

const { success, data } = await res.json()
console.log('ID новой записи:', data.id)

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/tasks/289/time', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    seconds: 1800,
    comment: 'Подготовка черновика',
  }),
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id number Идентификатор созданной записи. Используйте его для GET / PATCH / DELETE

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

HTTP 201 Created:

JSON
{
  "success": true,
  "data": {
    "id": 161
  }
}

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

400 — не передан обязательный seconds:

JSON
{
  "success": false,
  "error": {
    "code": "MISSING_PARAMS",
    "message": "Required: seconds (number)"
  }
}

Ошибки

HTTP Код Описание
400 MISSING_PARAMS Не передано поле seconds
422 BITRIX_ERROR Битрикс24 вернул ошибку (например, родительская задача недоступна)
403 SCOPE_DENIED API-ключ не имеет скоупа task
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

Известные особенности

Bitrix24 не проверяет существование userId. Метод task.elapseditem.add сохраняет запись с любым значением userId — даже несуществующим — и возвращает 201. Но такую «запись-призрак» затем нельзя ни прочитать, ни обновить, ни удалить через карточные методы: GET / PATCH / DELETE /v1/tasks/:taskId/time/:itemId вернут 422 (512/TE/ITEM_NOT_FOUND_OR_NOT_ACCESSIBLE). Она остаётся видна только в списках (GET /v1/tasks/:taskId/time, GET /v1/task-time) и засоряет отчёты без возможности очистки через API. Передавайте только реальные ID сотрудников из `GET /v1/users`.

Ответ — только id, без остальных полей. В отличие от создания задачи или комментария, метод возвращает только идентификатор. Чтобы получить полную запись с автогенерированными MINUTES, SOURCE, CREATED_DATE, DATE_START, DATE_STOP — сделайте `GET /v1/tasks/:taskId/time/:itemId`.

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