метод REST
scope: bizproc
bizproc.task.list
Получить список заданий бизнес-процесса
Описание
Метод bizproc.task.list получает список заданий бизнес-процессов.
Администратор портала может запросить все задания или задания любого пользователя. Обычный пользователь — свои задания или подчиненного.
Для запроса своих заданий можно не указывать фильтр по USER_ID.
На облачных Битрикс24 информация по заданиям доступна в течение суток после завершения бизнес-процесса.
Параметры
SELECT
array
необязательный
Массив содержит список полей, которые необходимо выбрать.
Можно указать только те поля, которые необходимы.
По умолчанию возвращает поля ENTITY, DOCUMENT_ID, ID, WORKFLOW_ID, DOCUMENT_NAME, NAME, DOCUMENT_URL
FILTER
object
необязательный
Объект для фильтрации списка заданий в формате {"field_1": "value_1", ... "field_N": "value_N"}, где
- field_N — поле задания для фильтра
- value_N — значение поля
Перед названием фильтруемого поля можно указать тип фильтрации:
- = — равно
- ! или != — не равно
- < — меньше
- <= — меньше либо равно
- > — больше
- >= — больше либо равно
Без префикса фильтр сравнивает значение на равенство. Название поля можно передавать в любом регистре.
Если в фильтре присутствует USER_ID, то проверяется субординация пользователей:
- руководитель может запросить список заданий своих подчиненных
- администратор может запрашивать задания любых пользователей без ограничений
Если метод вызывает не администратор и фильтр по USER_ID не указан, то по умолчанию выбираются задания текущего пользователя
ORDER
object
необязательный
Объект для сортировки списка заданий в формате {"field_1": "value_1", ... "field_N": "value_N"}, где
- field_N — поле задания для сортировки
- value_N — направление сортировки
Направление сортировки может принимать значения:
- asc — по возрастанию
- desc — по убыванию
Можно указать несколько полей для сортировки, например, {NAME: 'ASC', ID: 'DESC'}
START
integer
необязательный
Параметр используется для управления постраничной навигацией.
Размер страницы результатов всегда статичный — 50 записей.
Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.
Формула расчета значения параметра start:
start = (N - 1) * 50, где N — номер нужной страницы
Примеры запроса
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.listcurl -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);
}from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.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",
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.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",
},
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.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",
},
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {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>';// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "bizproc.task.list", b24.Params{
"SELECT": []string{"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": b24.Params{
"ID": "DESC",
},
"FILTER": b24.Params{
"USER_ID": 1,
"STATUS": 0,
"ACTIVITY": "RequestInformationOptionalActivity",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("bizproc.task.list: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)Ответ
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",
"WORKFLOW_ID": "67a2fda6732f98.84769464",
"DOCUMENT_NAME": "Партнерская конференция",
"DESCRIPTION": "",
"NAME": "Утвердить подрядчика",
"MODIFIED": "2025-02-05T08:58:14+03:00",
"WORKFLOW_STARTED": "2025-02-05T08:58:14+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": "ApproveActivity",
"ACTIVITY_NAME": "A3651_68033_56029_16414",
"PARAMETERS": {
"CommentLabel": "Комментарий",
"CommentRequired": "N",
"ShowComment": "Y",
"StatusYesLabel": "Утвердить",
"StatusNoLabel": "Отклонить"
},
"DOCUMENT_URL": "/bizproc/processes/?livefeed=y&list_id=171&element_id=2237"
}
],
"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
array
Корневой элемент ответа.
Содержит массив объектов с информацией о заданиях бизнес-процессов.
Каждый объект содержит поля задания, указанные в параметре SELECT
total
integer
Общее количество найденных записей
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "ACCESS_DENIED",
"error_description": "Access denied!"
}| Код | Описание | Значение |
|---|---|---|
ACCESS_DENIED |
Access denied! | Метод запустил не администратор или вы не можете просматривать задания указанного сотрудника |
ERROR_SELECT_VALIDATION_FAILURE |
Invalid data in SELECT parameter | В параметре SELECT переданы некорректные данные |
