Записать информацию в журнал бизнес-процесса bizproc.activity.log

Scope: bizproc

Кто может выполнять метод: администратор

Метод записывает информацию в журнал бизнес-процесса. Запись событий в журнал должна быть включена в шаблоне бизнес-процесса.

Пользовательская документация

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

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

Название
тип

Описание

EVENT_TOKEN*
string

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

Токен поступает на обработчик действия приложения, когда бизнес-процесс доходит до выполнения этого действия.

Запись в журнал возможна, если действие приложения подписано 'USE_SUBSCRIPTION': 'Y' на ход выполнения бизнес-процесса.

LOG_MESSAGE*
string

Сообщение для записи в лог

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"event_token":"55c1dc1c3f0d75.78875596|A51601_82584_96831_81132|hsyUws1j4XiwqPqN45eH66CcQtEvpUIP.47dd5d888e8e549d2c984713e12a4268e6e87d0208ca1f093ba1075e77f92e90","log_message":"Please wait for answer!"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/bizproc.activity.log
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"event_token":"55c1dc1c3f0d75.78875596|A51601_82584_96831_81132|hsyUws1j4XiwqPqN45eH66CcQtEvpUIP.47dd5d888e8e549d2c984713e12a4268e6e87d0208ca1f093ba1075e77f92e90","log_message":"Please wait for answer!","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/bizproc.activity.log
        
try
        {
        	const response = await $b24.callMethod(
        		'bizproc.activity.log',
        		{
        			event_token: '55c1dc1c3f0d75.78875596|A51601_82584_96831_81132|hsyUws1j4XiwqPqN45eH66CcQtEvpUIP.47dd5d888e8e549d2c984713e12a4268e6e87d0208ca1f093ba1075e77f92e90',
        			log_message: 'Please wait for answer!'
        		}
        	);
        	
        	const result = response.getData().result;
        	alert("Success: " + result);
        }
        catch( error )
        {
        	alert("Error: " + error);
        }
        
try {
            $eventToken = 'your_event_token'; // Replace with actual event token
            $message = 'Your log message'; // Replace with actual message
        
            $result = $serviceBuilder
                ->getBizProcScope()
                ->activity()
                ->log($eventToken, $message);
        
            if ($result->isSuccess()) {
                print($result->getCoreResponse()->getResponseData()->getResult()[0]);
            } else {
                print('Log entry failed.');
            }
        } catch (Throwable $e) {
            print('Error: ' . $e->getMessage());
        }
        
BX24.callMethod(
            'bizproc.activity.log',
            {
                event_token: '55c1dc1c3f0d75.78875596|A51601_82584_96831_81132|hsyUws1j4XiwqPqN45eH66CcQtEvpUIP.47dd5d888e8e549d2c984713e12a4268e6e87d0208ca1f093ba1075e77f92e90',
                log_message: 'Please wait for answer!'
            },
            function(result) {
                if(result.error())
                    alert("Error: " + result.error());
                else
                    alert("Success: " + result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'bizproc.activity.log',
            [
                'event_token' => '55c1dc1c3f0d75.78875596|A51601_82584_96831_81132|hsyUws1j4XiwqPqN45eH66CcQtEvpUIP.47dd5d888e8e549d2c984713e12a4268e6e87d0208ca1f093ba1075e77f92e90',
                'log_message' => 'Please wait for answer!'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 400

{
            "error": "ERROR_EMPTY_LOG_MESSAGE",
            "error_description": "Empty log message!"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Сообщение об ошибке

Описание

ERROR_EMPTY_LOG_MESSAGE

Empty log message!

не указан текст записи в журнал

Также метод может вернуть ошибки от бизнес-процесса.

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

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

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

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

Предыдущая
Удалить действие
Следующая
Обзор методов