Получить настройки отчетов 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>
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 |
Корневой элемент ответа |
|
active |
Активен ли модуль контроля времени |
|
user_id |
Идентификатор текущего пользователя |
|
user_admin |
Является ли пользователь администратором |
|
user_head |
Является ли пользователь руководителем |
|
departments |
Список объектов с информацией о подразделениях. Содержимое массива зависит от роли пользователя:
|
|
minimum_idle_for_report |
Минимальное время отсутствия в минутах, после которого требуется отчет |
|
report_view_type |
Тип просмотра отчетов. Возможные значения:
|
|
time |
Информация о времени выполнения запроса |
Объект departments
|
Название |
Описание |
|
id |
Идентификатор подразделения |
|
name |
Название подразделения |
Обработка ошибок
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Контроль времени: обзор методов
- Добавить отчет об отсутствии timeman.timecontrol.report.add
- Получить отчет о выявленных отсутствиях timeman.timecontrol.reports.get
- Получить список пользователей подразделения timeman.timecontrol.reports.users.get