Для AI-агентов: markdown этой страницы — /docs-content/workday/time-control-report-settings.md индекс документации — /llms.txt

Получить настройки отчёта контроля времени

GET /v1/workday/time-control/report-settings

Возвращает доступ владельца учётных данных к месячным отчётам контроля рабочего времени: его ID, роль и подразделения, по которым ему открыты отчёты. Вызывайте перед запросом месячного отчёта, чтобы узнать свой ID и доступных сотрудников.

Требуется скоуп timeman. Метод доступен любому сотруднику портала и описывает права того, чьими учётными данными сделан запрос: для личного ключа это владелец ключа, для ключа приложения — пользователь, чей токен сессии передан в Authorization. Ключ READONLY может читать настройки отчёта. Настройки контроля времени для всего портала — на странице Получить настройки контроля времени.

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/workday/time-control/report-settings" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/workday/time-control/report-settings" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workday/time-control/report-settings', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const { data } = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workday/time-control/report-settings', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean true при успешном запросе
data object Доступ владельца учётных данных к месячным отчётам
data.active boolean Включён ли контроль рабочего времени на портале. Изменить: Изменить настройки контроля времени
data.userId integer ID владельца учётных данных. Подходит для userId в месячном отчёте об отсутствиях, когда сотрудник запрашивает свой отчёт
data.userAdmin boolean Администратор ли владелец учётных данных
data.userHead boolean Руководит ли владелец учётных данных хотя бы одним подразделением
data.departments array Подразделения, по которым владельцу учётных данных доступны отчёты: администратору — все подразделения портала, руководителю — подразделения, которыми он руководит, остальным сотрудникам — пустой массив
data.departments[].id string ID подразделения. Подходит для departmentId в списке сотрудников подразделения
data.departments[].name string Название подразделения
data.minimumIdleForReport integer Отсутствие в минутах, начиная с которого у сотрудника запрашивается объяснение
data.reportViewType string Какие месячные отчёты видит владелец учётных данных: simple — только свой, head — отчёты сотрудников своих подразделений, full — отчёты всех сотрудников, none — отчёты недоступны

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

Ответ руководителю одного подразделения:

JSON 
{
  "success": true,
  "data": {
    "active": true,
    "userId": 547,
    "userAdmin": false,
    "userHead": true,
    "departments": [
      {
        "id": "9",
        "name": "Отдел маркетинга и рекламы"
      }
    ],
    "minimumIdleForReport": 15,
    "reportViewType": "head"
  }
}

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

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

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

Ошибки

HTTP Код Описание
409 TIMEMAN_MODULE_NOT_ENABLED Учёт рабочего времени недоступен на портале: инструмент «Рабочее время и отчёты» выключен в настройках портала или модуль не входит в тариф
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ответ неожиданной формы
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 TOKEN_MISSING Ключ приложения передан без токена сессии в Authorization: Bearer
401 INVALID_SESSION Токен сессии неверный или истёк
403 SCOPE_DENIED У ключа нет скоупа timeman
429 RATE_LIMITED Превышен общий лимит запросов, срок повтора — в заголовке Retry-After

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

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