Получить настройки отчетов timeman.timecontrol.reports.settings.get

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: timeman

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

Метод timeman.timecontrol.reports.settings.get получает настройки отчетов для построения интерфейса отчетов инструмента контроля времени.

Параметры метода

Без параметров.

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/timeman.timecontrol.reports.settings.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/timeman.timecontrol.reports.settings.get
        
try
        {
        	const response = await $b24.callMethod(
        		'timeman.timecontrol.reports.settings.get',
        		{}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'timeman.timecontrol.reports.settings.get',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting time control reports settings: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'timeman.timecontrol.reports.settings.get',
            {},
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'timeman.timecontrol.reports.settings.get',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "active": true,
                "user_id": 547,
                "user_admin": false,
                "user_head": true,
                "departments": [
                    {
                        "id": "9",
                        "name": "Отдел маркетинга и рекламы"
                    }
                ],
                "minimum_idle_for_report": 15,
                "report_view_type": "head"
            },
            "time": {
                "start": 1749211142.210397,
                "finish": 1749211142.280698,
                "duration": 0.07030105590820312,
                "processing": 0.03640604019165039,
                "date_start": "2025-06-06T14:59:02+03:00",
                "date_finish": "2025-06-06T14:59:02+03:00",
                "operating_reset_at": 1749211742,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

Корневой элемент ответа

active
boolean

Активен ли модуль контроля времени

user_id
integer

Идентификатор текущего пользователя

user_admin
boolean

Является ли пользователь администратором

user_head
boolean

Является ли пользователь руководителем

departments
array

Список объектов с информацией о подразделениях. Содержимое массива зависит от роли пользователя:

  • Администратор — описание всех подразделений,
  • Руководитель — описание своего подразделения,
  • Обычный сотрудник — пустой массив

minimum_idle_for_report
integer

Минимальное время отсутствия в минутах, после которого требуется отчет

report_view_type
string

Тип просмотра отчетов. Возможные значения:

  • none — нет доступа к отчетам
  • head — руководитель
  • full — полный доступ
  • simple — упрощенный доступ

time
time

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

Объект departments

Название
тип

Описание

id
string

Идентификатор подразделения

name
string

Название подразделения

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

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Установить настройки инструмента контроля времени
Следующая
Получить список пользователей