How to Mass Finish Workflows with Date Filter
Scope:
bizprocWho can execute methods: administrator
During the use of Bitrix24, there may be accumulated stuck workflows or processes that remain in the "In Progress" status for too long and become irrelevant.
To mass finish old workflows, we will sequentially execute two methods:
- bizproc.workflow.instances — we will get a filtered list of processes
- bizproc.workflow.kill — we will finish the workflows with data deletion. If you need to keep the fact of the workflow's launch, use the method bizproc.workflow.terminate. Both methods are called in the same way.
1. Get the List of Processes
We will use the method bizproc.workflow.instances with a filter:
<STARTED— we will specify the start date with the prefix<, only those processes that were started before this date will be selected.
How to Use Examples in Documentation
JS
PHP
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'
]
]
);
As a result, we will get the ID of all active workflows that were started before the specified date.
{
"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. Finish the Workflows
We will use the method bizproc.workflow.kill with the parameter:
ID— the identifier of the process, we pass theIDobtained in step 1.
JS
PHP
BX24.callMethod(
'bizproc.workflow.kill',
{
ID: '660e559f34af10.95144732',
},
);
require_once('crest.php');
$result = CRest::call(
'bizproc.workflow.kill',
[
'ID' => '660e559f34af10.95144732'
]
);
As a result, we will receive true, indicating that the process was successfully deleted. If you received an error, check the possible error descriptions in the documentation for the method bizproc.workflow.kill.
{
"result": true,
}
Code Example
In the example, all found processes are deleted in a loop. When deleting a large volume of data, there may be limitations on request execution. To optimize the code for your workload, use the recommendations in the Performance section.
JS
PHP
// Function to convert date from dd.mm.yyyy format to ISO format
function convertDateToISO(dateString) {
const [day, month, year] = dateString.split('.');
return `${year}-${month}-${day}T00:00:00Z`;
}
// Request date from user
const userDateInput = prompt("Enter date in dd.mm.yyyy format:");
const isoDate = convertDateToISO(userDateInput);
// Call the bizproc.workflow.instances method with date filter
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;
// Call the bizproc.workflow.kill method for each ID
BX24.callMethod(
'bizproc.workflow.kill',
{
ID: instanceId
},
function(killResult) {
if (killResult.error()) {
console.error(`Error deleting process ${instanceId}:`, killResult.error());
} else {
console.log(`Process ${instanceId} successfully deleted.`);
}
}
);
});
if (result.more()) {
result.next();
}
}
}
);
require_once('crest.php');
// Function to convert date from dd.mm.yyyy format to ISO format
function convertDateToISO($dateString) {
list($day, $month, $year) = explode('.', $dateString);
return "{$year}-{$month}-{$day}T00:00:00Z";
}
// Request date from user
$userDateInput = readline("Enter date in dd.mm.yyyy format: ");
$isoDate = convertDateToISO($userDateInput);
// Call the bizproc.workflow.instances method with date filter
$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'];
// Call the bizproc.workflow.kill method for each ID
$killResult = CRest::call(
'bizproc.workflow.kill',
[
'ID' => $instanceId
]
);
if (!empty($killResult['error'])) {
echo "Error deleting process {$instanceId}: " . $killResult['error_description'] . "\n";
} else {
echo "Process {$instanceId} successfully deleted.\n";
}
}
// Check for additional data
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'];
// Call the bizproc.workflow.kill method for each ID
$killResult = CRest::call(
'bizproc.workflow.kill',
[
'ID' => $instanceId
]
);
if (!empty($killResult['error'])) {
echo "Error deleting process {$instanceId}: " . $killResult['error_description'] . "\n";
} else {
echo "Process {$instanceId} successfully deleted.\n";
}
}
}
}
Copied