Получить список заданий бизнес-процесса bizproc.task.list
Scope:
bizprocКто может выполнять метод: любой пользователь
Метод bizproc.task.list получает список заданий бизнес-процессов.
Администратор портала может запросить все задания или задания любого пользователя. Обычный пользователь — свои задания или подчиненного.
Для запроса своих заданий можно не указывать фильтр по USER_ID.
На облачных Битрикс24 информация по заданиям доступна в течение суток после завершения бизнес-процесса.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
SELECT |
Массив содержит список полей, которые необходимо выбрать. Можно указать только те поля, которые необходимы. По умолчанию возвращает поля |
|
FILTER |
Объект для фильтрации списка заданий в формате
Если в фильтре присутствует
Если метод вызывает не администратор и фильтр по |
|
ORDER |
Объект для сортировки списка заданий в формате
Направление сортировки может принимать значения:
Можно указать несколько полей для сортировки, например, |
|
START |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, необходимо передавать значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["ID","WORKFLOW_ID","DOCUMENT_NAME","DESCRIPTION","NAME","MODIFIED","WORKFLOW_STARTED","WORKFLOW_STARTED_BY","OVERDUE_DATE","WORKFLOW_TEMPLATE_ID","WORKFLOW_TEMPLATE_NAME","WORKFLOW_STATE","STATUS","USER_ID","USER_STATUS","MODULE_ID","ENTITY","DOCUMENT_ID","ACTIVITY","ACTIVITY_NAME","DOCUMENT_URL","PARAMETERS"],"order":{"ID":"DESC"},"filter":{"USER_ID":1,"STATUS":0,"ACTIVITY":"RequestInformationOptionalActivity"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/bizproc.task.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["ID","WORKFLOW_ID","DOCUMENT_NAME","DESCRIPTION","NAME","MODIFIED","WORKFLOW_STARTED","WORKFLOW_STARTED_BY","OVERDUE_DATE","WORKFLOW_TEMPLATE_ID","WORKFLOW_TEMPLATE_NAME","WORKFLOW_STATE","STATUS","USER_ID","USER_STATUS","MODULE_ID","ENTITY","DOCUMENT_ID","ACTIVITY","ACTIVITY_NAME","DOCUMENT_URL","PARAMETERS"],"order":{"ID":"DESC"},"filter":{"USER_ID":1,"STATUS":0,"ACTIVITY":"RequestInformationOptionalActivity"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/bizproc.task.list
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
const parameters = {
select: [
'ID',
'WORKFLOW_ID',
'DOCUMENT_NAME',
'DESCRIPTION',
'NAME',
'MODIFIED',
'WORKFLOW_STARTED',
'WORKFLOW_STARTED_BY',
'OVERDUE_DATE',
'WORKFLOW_TEMPLATE_ID',
'WORKFLOW_TEMPLATE_NAME',
'WORKFLOW_STATE',
'STATUS',
'USER_ID',
'USER_STATUS',
'MODULE_ID',
'ENTITY',
'DOCUMENT_ID',
'ACTIVITY',
'ACTIVITY_NAME',
'DOCUMENT_URL',
'PARAMETERS'
],
order: {
ID: 'DESC'
},
filter: {
'USER_ID': 1,
'STATUS': 0,
'ACTIVITY': 'RequestInformationOptionalActivity'
}
};
try {
const response = await $b24.callListMethod('bizproc.task.list', parameters);
const items = response.getData() || [];
for (const entity of items) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', error);
}
// fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
const parameters = {
select: [
'ID',
'WORKFLOW_ID',
'DOCUMENT_NAME',
'DESCRIPTION',
'NAME',
'MODIFIED',
'WORKFLOW_STARTED',
'WORKFLOW_STARTED_BY',
'OVERDUE_DATE',
'WORKFLOW_TEMPLATE_ID',
'WORKFLOW_TEMPLATE_NAME',
'WORKFLOW_STATE',
'STATUS',
'USER_ID',
'USER_STATUS',
'MODULE_ID',
'ENTITY',
'DOCUMENT_ID',
'ACTIVITY',
'ACTIVITY_NAME',
'DOCUMENT_URL',
'PARAMETERS'
],
order: {
ID: 'DESC'
},
filter: {
'USER_ID': 1,
'STATUS': 0,
'ACTIVITY': 'RequestInformationOptionalActivity'
}
};
try {
const generator = $b24.fetchListMethod('bizproc.task.list', parameters, 'ID');
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity); }
}
} catch (error) {
console.error('Request failed', error);
}
// callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
const parameters = {
select: [
'ID',
'WORKFLOW_ID',
'DOCUMENT_NAME',
'DESCRIPTION',
'NAME',
'MODIFIED',
'WORKFLOW_STARTED',
'WORKFLOW_STARTED_BY',
'OVERDUE_DATE',
'WORKFLOW_TEMPLATE_ID',
'WORKFLOW_TEMPLATE_NAME',
'WORKFLOW_STATE',
'STATUS',
'USER_ID',
'USER_STATUS',
'MODULE_ID',
'ENTITY',
'DOCUMENT_ID',
'ACTIVITY',
'ACTIVITY_NAME',
'DOCUMENT_URL',
'PARAMETERS'
],
order: {
ID: 'DESC'
},
filter: {
'USER_ID': 1,
'STATUS': 0,
'ACTIVITY': 'RequestInformationOptionalActivity'
}
};
try {
const response = await $b24.callMethod('bizproc.task.list', parameters, 0);
const result = response.getData().result || [];
for (const entity of result) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', error);
}
try {
$response = $b24Service
->core
->call(
'bizproc.task.list',
[
'select' => [
'ID',
'WORKFLOW_ID',
'DOCUMENT_NAME',
'DESCRIPTION',
'NAME',
'MODIFIED',
'WORKFLOW_STARTED',
'WORKFLOW_STARTED_BY',
'OVERDUE_DATE',
'WORKFLOW_TEMPLATE_ID',
'WORKFLOW_TEMPLATE_NAME',
'WORKFLOW_STATE',
'STATUS',
'USER_ID',
'USER_STATUS',
'MODULE_ID',
'ENTITY',
'DOCUMENT_ID',
'ACTIVITY',
'ACTIVITY_NAME',
'DOCUMENT_URL',
'PARAMETERS'
],
'order' => [
'ID' => 'DESC'
],
'filter' => [
'USER_ID' => 1,
'STATUS' => 0,
'ACTIVITY' => 'RequestInformationOptionalActivity'
]
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'bizproc.task.list',
{
select: [
'ID',
'WORKFLOW_ID',
'DOCUMENT_NAME',
'DESCRIPTION',
'NAME',
'MODIFIED',
'WORKFLOW_STARTED',
'WORKFLOW_STARTED_BY',
'OVERDUE_DATE',
'WORKFLOW_TEMPLATE_ID',
'WORKFLOW_TEMPLATE_NAME',
'WORKFLOW_STATE',
'STATUS',
'USER_ID',
'USER_STATUS',
'MODULE_ID',
'ENTITY',
'DOCUMENT_ID',
'ACTIVITY',
'ACTIVITY_NAME',
'DOCUMENT_URL',
'PARAMETERS'
],
order: {
ID: 'DESC'
},
filter: {
'USER_ID': 1,
'STATUS': 0,
'ACTIVITY': 'RequestInformationOptionalActivity'
}
},
function(result)
{
if(result.error())
alert("Error: " + result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'bizproc.task.list',
[
'select' => [
'ID',
'WORKFLOW_ID',
'DOCUMENT_NAME',
'DESCRIPTION',
'NAME',
'MODIFIED',
'WORKFLOW_STARTED',
'WORKFLOW_STARTED_BY',
'OVERDUE_DATE',
'WORKFLOW_TEMPLATE_ID',
'WORKFLOW_TEMPLATE_NAME',
'WORKFLOW_STATE',
'STATUS',
'USER_ID',
'USER_STATUS',
'MODULE_ID',
'ENTITY',
'DOCUMENT_ID',
'ACTIVITY',
'ACTIVITY_NAME',
'DOCUMENT_URL',
'PARAMETERS'
],
'order' => [
'ID' => 'DESC'
],
'filter' => [
'USER_ID' => 1,
'STATUS' => 0,
'ACTIVITY' => 'RequestInformationOptionalActivity'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"ENTITY": "BizprocDocument",
"DOCUMENT_ID": "2249",
"ID": "1477",
"WORKFLOW_ID": "67a2ffdb2c57a3.35276854",
"DOCUMENT_NAME": "Партнерская конференция",
"DESCRIPTION": "",
"NAME": "Добавить информацию о подрядчике",
"MODIFIED": "2025-02-05T09:06:19+03:00",
"WORKFLOW_STARTED": "2025-02-05T09:06:19+03:00",
"WORKFLOW_STARTED_BY": "1",
"OVERDUE_DATE": null,
"WORKFLOW_TEMPLATE_ID": "565",
"WORKFLOW_TEMPLATE_NAME": "Организация мероприятия",
"WORKFLOW_STATE": "Ожидание дополнительной информации",
"STATUS": "0",
"USER_ID": "1",
"USER_STATUS": "0",
"MODULE_ID": "lists",
"ACTIVITY": "RequestInformationActivity",
"ACTIVITY_NAME": "A3651_68033_56029_16413",
"PARAMETERS": {
"CommentLabel": "Комментарий",
"CommentRequired": "Y",
"ShowComment": "Y",
"StatusOkLabel": "Сохранить результат",
"Fields": [
{
"Id": "contractor",
"Type": "E:ECrm",
"Name": "Подрядчик",
"Description": "Кто выполняет работы",
"Multiple": false,
"Required": true,
"Options": {
"LEAD": "N",
"CONTACT": "Y",
"COMPANY": "Y",
"DEAL": "N",
"SMART_INVOICE": "N",
"DYNAMIC_136": "N",
"DYNAMIC_1038": "N"
},
"Settings": null,
"Default": [
"C_607"
]
},
{
"Id": "phone_number",
"Type": "string",
"Name": "Номер телефона",
"Description": "",
"Multiple": false,
"Required": true,
"Options": null,
"Settings": null,
"Default": ""
}
]
},
"DOCUMENT_URL": "/bizproc/processes/?livefeed=y&list_id=171&element_id=2249"
},
{
"ENTITY": "BizprocDocument",
"DOCUMENT_ID": "2237",
"ID": "1471",
...
}
],
"total": 2,
"time": {
"start": 1738735796.4730229,
"finish": 1738735796.510215,
"duration": 0.037192106246948242,
"processing": 0.0080459117889404297,
"date_start": "2025-02-05T09:09:56+03:00",
"date_finish": "2025-02-05T09:09:56+03:00",
"operating_reset_at": 1738736396,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Cодержит массив объектов с информацией о заданиях бизнес-процессов. Каждый объект содержит поля задания, указанные в параметре |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Поля задания
|
Название |
Описание |
|
ID |
Идентификатор задания |
|
WORKFLOW_ID |
Идентификатор бизнес-процесса |
|
DOCUMENT_NAME |
Название документа |
|
DESCRIPTION |
Описание задания |
|
NAME |
Название задания |
|
MODIFIED |
Дата изменения |
|
WORKFLOW_STARTED |
Дата запуска бизнес-процесса |
|
WORKFLOW_STARTED_BY |
Кем запущен бизнес-процесс |
|
OVERDUE_DATE |
Крайний срок |
|
WORKFLOW_TEMPLATE_ID |
Идентификатор шаблона бизнес-процесса |
|
WORKFLOW_TEMPLATE_NAME |
Название шаблона бизнес-процесса |
|
WORKFLOW_STATE |
Статус бизнес-процесса |
|
STATUS |
Статус задания. Возможные значения:
|
|
USER_ID |
Идентификатор пользователя |
|
USER_STATUS |
Ответ пользователя. Возможные значения:
|
|
MODULE_ID |
Идентификатор модуля по документу |
|
ENTITY |
Символьный идентификатор объекта по документу |
|
DOCUMENT_ID |
Идентификатор документа |
|
ACTIVITY |
Идентификатор типа задания. Возможные значения:
|
|
ACTIVITY_NAME |
Идентификатор действия в шаблоне |
|
PARAMETERS |
Объект с описанием параметров задания |
|
DOCUMENT_URL |
Ссылка на документ |
Объект PARAMETERS
|
Название |
Описание |
|
CommentLabel |
Название поля Комментарий |
|
CommentRequired |
Обязательность комментария. Допустимые значения:
|
|
ShowComment |
Показывать комментарий. Допустимые значения:
|
|
StatusOkLabel |
Текст кнопки Ознакомлен |
|
StatusYesLabel |
Текст кнопки Утвердить |
|
StatusNoLabel |
Текст кнопки Отклонить |
|
Fields |
Массив объектов. Каждый объект содержит описание поля в задании |
Объект Fields
|
Название |
Описание |
|
Id |
Символьный идентификатор параметра задания |
|
Type |
Тип параметра. Базовые значения:
Остальные типы зависят от документа, с которым работает бизнес-процесс |
|
Name |
Наименование параметра |
|
Description |
Описание параметра |
|
Multiple |
Множественность параметра. Возможные значения:
|
|
Required |
Обязательность параметра. Возможные значения:
|
|
Options |
Настройки поля. Значения зависят от типа параметра. Примеры:
|
|
Settings |
Дополнительные настройки поля |
|
Default |
Значение параметра по умолчанию |
Обработка ошибок
HTTP-статус: 400
{
"error": "ACCESS_DENIED",
"error_description": "Access denied!"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Сообщение об ошибке |
Описание |
|
|
Access denied! |
Метод запустил не администратор или вы не можете просматривать задания указанного сотрудника |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Задания бизнес-процессов: обзор методов
- Выполнить задание бизнес-процесса bizproc.task.complete
- Делегировать задание бизнес-процесса bizproc.task.delegate
- Как завершить бизнес-процессы уволенного сотрудника
- Как массово завершить бизнес-процессы с фильтром по дате