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

Остановить таймер задачи

POST /v1/tasks/:taskId/pause-timer

Останавливает таймер учёта времени, который пользователь ключа запустил по задаче, и записывает отработанное время в учёт времени задачи.

Параметры

Параметр Тип Обяз. Описание
taskId (path) number да ID задачи. Список: GET /v1/tasks

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

Поле Тип Обяз. Описание
params object нет Дополнительные параметры действия. Передаются в Битрикс24 без изменений

Тело запроса может быть пустым или {}. Другие поля, кроме params, отклоняются с 400 INVALID_PARAMS.

Примеры

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

Terminal 
curl -X POST 'https://vibecode.bitrix24.tech/v1/tasks/289/pause-timer' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'

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

Terminal 
curl -X POST 'https://vibecode.bitrix24.tech/v1/tasks/289/pause-timer' \
  -H 'X-Api-Key: YOUR_APP_KEY' \
  -H 'Authorization: Bearer USER_SESSION_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'

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

javascript 
const response = await fetch('https://vibecode.bitrix24.tech/v1/tasks/289/pause-timer', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
const result = await response.json()
console.log(result.data)

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

javascript 
const response = await fetch('https://vibecode.bitrix24.tech/v1/tasks/289/pause-timer', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
const result = await response.json()
console.log(result.data)

Поля ответа

Поле Тип Описание
success boolean true при успехе
data object | null null, если у задачи выключен учёт времени. Вызов в этом случае ничего не меняет
data.task object Полный объект задачи, когда учёт времени включён. Значения приходят в исходном виде: числа строками ("id": "289"), флаги — Y или N ("allowTimeTracking": "Y"). В GET /v1/tasks/:id те же поля приходят числами и true/false
data.task.id string ID задачи
data.task.status string Статус задачи. Остановка таймера его не меняет: задача остаётся в 3 — «Выполняется»
data.task.allowTimeTracking string Учёт времени у задачи: Y — включён
data.task.action object Какие действия доступны пользователю ключа: ключ — имя действия (start, pause, complete, defer, renew и другие), значение — true или false

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

Учёт времени включён. Показаны основные поля объекта задачи:

JSON 
{
  "success": true,
  "data": {
    "task": {
      "id": "289",
      "title": "Подготовить отчёт за квартал",
      "status": "3",
      "createdBy": "1",
      "responsibleId": "1",
      "allowTimeTracking": "Y",
      "timeElapsed": "6",
      "action": {
        "start": false,
        "pause": true,
        "complete": true,
        "defer": false,
        "renew": false
      }
    }
  }
}

Учёт времени у задачи выключен:

JSON 
{
  "success": true,
  "data": null
}

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

422 — таймер по задаче не запущен:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Не удалось остановить таймер выполнения задачи",
    "b24Code": "0"
  }
}

Текст error.message приходит от Битрикс24, его формулировка и язык зависят от языка портала. Ветвитесь по error.code, а не по тексту сообщения.

Ошибки

HTTP Код Описание
400 INVALID_PARAMS taskId не положительное целое число: taskId must be a positive integer
400 INVALID_PARAMS Тело запроса не JSON-объект: body must be an object
400 INVALID_PARAMS В теле есть поля кроме params: body contains unsupported fields
400 INVALID_PARAMS params не объект: params must be an object
401 MISSING_API_KEY Не передан X-Api-Key
401 INVALID_API_KEY Ключ не найден
401 TOKEN_MISSING У ключа нет действующего токена Битрикс24
403 SCOPE_DENIED У ключа нет скоупа task или tasks
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения
403 BITRIX_ACCESS_DENIED У пользователя ключа нет прав на задачу
422 BITRIX_ERROR Учёт времени включён, но таймер по задаче не запущен: Не удалось остановить таймер выполнения задачи
422 BITRIX_ERROR Задачи с таким taskId нет: Task not found or not accessible

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

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

  • Без учёта времени вызов ничего не делает, а ответ успешный. Если у задачи выключен allowTimeTracking, приходит 200 с data: null. Учёт времени включается полем allowTimeTracking при создании или обновлении задачи.
  • Остановка таймера не ставит задачу на паузу. Задача остаётся в статусе «Выполняется». Чтобы вернуть её в «Ждёт выполнения», вызовите паузу задачи.
  • Где увидеть отработанное время. Каждая остановка добавляет запись в учёт времени задачи: время начала и конца отрезка и его длительность в секундах.

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