Добавить отчет об отсутствии timeman.timecontrol.report.add

Scope: timeman

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

Метод timeman.timecontrol.report.add отправляет отчет об отсутствии и добавляет его в календарь.

По умолчанию пользователь может отправить отчет только для себя. Администратор портала может отправить отчет любому — для этого в параметре USER_ID нужно указать идентификатор пользователя.

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

Обязательные параметры отмечены *

Название
тип

Описание

REPORT_ID* | ID*
integer

Идентификатор записи об отсутствии.

Получить идентификаторы записей можно методом timeman.timecontrol.reports.get

USER_ID
integer

Идентификатор пользователя. Может указать только администратор.

Получить идентификатор пользователя можно методом user.get

TEXT*
string

Текст отчета

TYPE
string

Тип отчета:

  • WORK — рабочий
  • PRIVATE — личный

Значение по умолчанию — PRIVATE

CALENDAR
string

Добавлять событие в календарь:

  • Y — да
  • N — нет

Значение по умолчанию — Y

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"REPORT_ID":123,"TEXT":"Работал над проектом","TYPE":"WORK","CALENDAR":"Y"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/timeman.timecontrol.report.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"REPORT_ID":123,"TEXT":"Работал над проектом","TYPE":"WORK","CALENDAR":"Y","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/timeman.timecontrol.report.add
        
try
        {
        	const response = await $b24.callMethod(
        		'timeman.timecontrol.report.add',
        		{
        			'REPORT_ID': 123,
        			'TEXT': 'Работал над проектом',
        			'TYPE': 'WORK',
        			'CALENDAR': 'Y'
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'timeman.timecontrol.report.add',
                    [
                        'REPORT_ID' => 123,
                        'TEXT'      => 'Работал над проектом',
                        'TYPE'      => 'WORK',
                        'CALENDAR'  => 'Y',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding time control report: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'timeman.timecontrol.report.add',
            {
                'REPORT_ID': 123,
                'TEXT': 'Работал над проектом',
                'TYPE': 'WORK',
                'CALENDAR': 'Y'
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'timeman.timecontrol.report.add',
            [
                'REPORT_ID' => 123,
                'TEXT' => 'Работал над проектом',
                'TYPE' => 'WORK',
                'CALENDAR' => 'Y'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1743056587.6559751,
                "finish": 1743056587.8529301,
                "duration": 0.19695496559143066,
                "processing": 0.16714906692504883,
                "date_start": "2025-03-27T09:23:07+03:00",
                "date_finish": "2025-03-27T09:23:07+03:00",
                "operating_reset_at": 1743057187,
                "operating": 0.1671299934387207
            }
        }
        

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

Название
тип

Описание

result
boolean

Результат выполнения. Возвращает true, если отчет добавлен успешно

time
time

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

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

HTTP-статус: 400

{
            "error": "TEXT_EMPTY",
            "error_description": "Text can't be empty"
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

ACCESS_ERROR

You don't have access for this report

У вас нет доступа к этому отчету

TEXT_EMPTY

Text can't be empty

Текст отчета не может быть пустым

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

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

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

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