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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной 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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type TimeControlReportsSettingsResult = {
  active: boolean
  user_id: number
  user_admin: boolean
  user_head: boolean
  departments: { id: string; name: string }[]
  minimum_idle_for_report: number
  report_view_type: 'none' | 'head' | 'full' | 'simple'
}

try {
  const response = await $b24.actions.v2.call.make<TimeControlReportsSettingsResult>({
    method: 'timeman.timecontrol.reports.settings.get',
    params: {},
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(
      'active:', result.active,
      'user_id:', result.user_id,
      'report_view_type:', result.report_view_type,
      'departments:', result.departments
    )
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getTimeControlReportsSettings() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'timeman.timecontrol.reports.settings.get',
        params: {},
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(
        'active:', result.active,
        'user_id:', result.user_id,
        'report_view_type:', result.report_view_type,
        'departments:', result.departments
      )
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getTimeControlReportsSettings)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.timeman.timecontrol.reports.settings.get().response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "timeman.timecontrol.reports.settings.get", nil, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("timeman.timecontrol.reports.settings.get: %w", err)
}

var item struct {
	Active               bool   `json:"active"`
	UserID               int    `json:"user_id"`
	UserAdmin            bool   `json:"user_admin"`
	UserHead             bool   `json:"user_head"`
	MinimumIdleForReport int    `json:"minimum_idle_for_report"`
	ReportViewType       string `json:"report_view_type"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Active, item.UserID)

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

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-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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