Как массово завершить бизнес-процессы с фильтром по дате

Scope: bizproc

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

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

В процессе работы с Битрикс24 могут накапливаться зависшие бизнес-процессы или процессы, которые остаются в статусе «Выполняется» слишком долго и становятся неактуальными.

Чтобы массово завершить старые бизнес-процессы, последовательно выполним два метода:

  1. bizproc.workflow.instances — получим отфильтрованный список процессов
  2. bizproc.workflow.kill — завершим бизнес-процессы с удалением данных. Если нужно сохранить факт запуска бизнес-процесса, используйте метод bizproc.workflow.terminate. Оба метода вызываются одинаково

1. Получим список процессов

Используем метод bizproc.workflow.instances с фильтром:

  • <STARTED — укажем дату запуска с префиксом <, будут отобраны только те процессы, которые были запущены до этой даты

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

BX24.callMethod(
            'bizproc.workflow.instances',
            {
                filter: {
                    '<STARTED': '2025-01-01T00:00:00Z'
                }
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'bizproc.workflow.instances',
            [
                'filter' => [
                    '<STARTED' => '2025-01-01T00:00:00Z'
                ]
            ]
        );

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

{
            "result": [
                {
                    "ID": "660e559f34af10.95144732",
                    "MODIFIED": "2024-12-04T10:04:24+03:00",
                    "OWNED_UNTIL": null
                },
                {
                    "ID": "6639c7b59e9eb5.40607056",
                    "MODIFIED": "2024-12-04T09:52:40+03:00",
                    "OWNED_UNTIL": null
                },
                {
                    "ID": "66ea9200131729.26195442",
                    "MODIFIED": "2024-09-18T11:42:28+03:00",
                    "OWNED_UNTIL": null
                },
                {
                    "ID": "65ef0868368978.47049110",
                    "MODIFIED": "2024-03-11T16:34:32+03:00",
                    "OWNED_UNTIL": null
                }
            ],
            "total": 4,
        }

2. Завершим бизнес-процессы

Используем метод bizproc.workflow.kill с параметром:

  • ID — идентификатор процесса, передаем ID, полученный на шаге 1
BX24.callMethod(
            'bizproc.workflow.kill',
            {
                ID: '660e559f34af10.95144732',
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'bizproc.workflow.kill',
            [
                'ID' => '660e559f34af10.95144732'
            ]
        );

В результате получим true, удаление процесса прошло успешно. Если вы получили ошибку error, изучите описание возможных ошибок в документации метода bizproc.workflow.kill.

{
            "result": true,
        }

Пример кода

В примере все найденные процессы удаляются в цикле. При удалении большого объема данных возможны ограничения на выполнение запросов. Чтобы оптимизировать код под ваш объем работы, используйте рекомендации раздела Производительность.

// Функция для преобразования даты из формата дд.мм.гггг в формат ISO
        function convertDateToISO(dateString) {
            const [day, month, year] = dateString.split('.');
            return `${year}-${month}-${day}T00:00:00Z`;
        }
        
        // Запрос даты у пользователя
        const userDateInput = prompt("Введите дату в формате дд.мм.гггг:");
        const isoDate = convertDateToISO(userDateInput);
        
        // Вызов метода bizproc.workflow.instances с фильтром по дате
        BX24.callMethod(
            'bizproc.workflow.instances',
            {
                filter: {
                    '<STARTED': isoDate
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    const instances = result.data();
                    instances.forEach(instance => {
                        const instanceId = instance.ID;
                        
                        // Вызов метода bizproc.workflow.kill для каждого ID
                        BX24.callMethod(
                            'bizproc.workflow.kill',
                            {
                                ID: instanceId
                            },
                            function(killResult) {
                                if (killResult.error()) {
                                    console.error(`Ошибка при удалении процесса ${instanceId}:`, killResult.error());
                                } else {
                                    console.log(`Процесс ${instanceId} успешно удален.`);
                                }
                            }
                        );
                    });
        
                    if (result.more()) {
                        result.next();
                    }
                }
            }
        );
        
require_once('crest.php');
        
        // Функция для преобразования даты из формата дд.мм.гггг в формат ISO
        function convertDateToISO($dateString) {
            list($day, $month, $year) = explode('.', $dateString);
            return "{$year}-{$month}-{$day}T00:00:00Z";
        }
        
        // Запрос даты у пользователя
        $userDateInput = readline("Введите дату в формате дд.мм.гггг: ");
        $isoDate = convertDateToISO($userDateInput);
        
        // Вызов метода bizproc.workflow.instances с фильтром по дате
        $result = CRest::call(
            'bizproc.workflow.instances',
            [
                'filter' => [
                    '<STARTED' => $isoDate
                ]
            ]
        );
        
        if (!empty($result['error'])) {
            echo "Error: " . $result['error_description'];
        } else {
            $instances = $result['result'];
            foreach ($instances as $instance) {
                $instanceId = $instance['ID'];
        
                // Вызов метода bizproc.workflow.kill для каждого ID
                $killResult = CRest::call(
                    'bizproc.workflow.kill',
                    [
                        'ID' => $instanceId
                    ]
                );
        
                if (!empty($killResult['error'])) {
                    echo "Ошибка при удалении процесса {$instanceId}: " . $killResult['error_description'] . "\n";
                } else {
                    echo "Процесс {$instanceId} успешно удален.\n";
                }
            }
        
            // Проверка на наличие дополнительных данных
            while (!empty($result['next'])) {
                $result = CRest::call(
                    'bizproc.workflow.instances',
                    [
                        'filter' => [
                            '<STARTED' => $isoDate
                        ],
                        'start' => $result['next']
                    ]
                );
        
                $instances = $result['result'];
                foreach ($instances as $instance) {
                    $instanceId = $instance['ID'];
        
                    // Вызов метода bizproc.workflow.kill для каждого ID
                    $killResult = CRest::call(
                        'bizproc.workflow.kill',
                        [
                            'ID' => $instanceId
                        ]
                    );
        
                    if (!empty($killResult['error'])) {
                        echo "Ошибка при удалении процесса {$instanceId}: " . $killResult['error_description'] . "\n";
                    } else {
                        echo "Процесс {$instanceId} успешно удален.\n";
                    }
                }
            }
        }
Предыдущая
Как завершить бизнес-процессы уволенного сотрудника
Следующая
Пример создания чат-бота