bizproc.task.list

Scope: bizproc Права на выполнение: для всех

Описание

bizproc.task.list - метод возвращает список заданий бизнес-процессов. Метод доступен не только для администраторов. Обычный пользователь может запросить задания свои или своего подчиненного. Для запроса своих заданий не-администратору не указывать фильтр по USER_ID.

Параметры

Параметр Описание Значение по умолчанию

SELECT

Параметр	Описание	Значение по умолчанию
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` - статус задания: `0` - выполняется; `1` - утверждено (ответ Да); `2` - отклонено (ответ Нет); `3` - выполнено (ответ Ок); `4` - таймаут (истек срок выполнения задания). `USER_ID` - идентификатор пользователя; `USER_STATUS` - ответ пользователя: `0` - ожидание ответа; `1` - да (утвердил); `2` - нет (отклонил); `3` - ок (выполнил). `MODULE_ID` - идентификатор модуля (по документу); `ENTITY` - идентификатор сущности (по документу); `DOCUMENT_ID` - идентификатор документа. `ACTIVITY` - идентификатор типа задания, строка, варианты значений: `ApproveActivity` - Утверждение документа `ReviewActivity` - Ознакомление с документом `RequestInformationActivity` - Запрос дополнительной информации `RequestInformationOptionalActivity` - Запрос дополнительной информации (с отклонением) `ACTIVITY_NAME` - идентификатор действия в шаблоне. `PARAMETERS` - параметры задания, массив, который может содержать следующую информацию: `CommentLabelMessage` - Название поля "Комментарий"; `CommentRequired` - Обязательность комментария. Допустимые значения N (нет), Y (да), YA (да при утверждении), YR (да при отклонении); `ShowComment` - Показывать комментарий, Y/N; `TaskButtonMessage` - текст кнопки "Ознакомлен"; `TaskButton1Message` - текст кнопки "Утвердить"; `TaskButton2Message` - текст кнопки "Отклонить"; `Fields` - массив с описанием полей ( с версии 20.0.800 С версии 20.0.800 модуля Бизнес-процессы появилась возможность выполнять задания Запрос доп.информации через rest метод bizrpoc.task.complete. Для того, чтобы понять, какие поля нужно заполнить, в метод bizproc.task.list в PARAMETERS добавлено новое свойство `Fields`. );	`['ID', 'WORKFLOW_ID', 'DOCUMENT_NAME', 'NAME']` Важно: 'MODULE', 'ENTITY', 'DOCUMENT_ID', 'DOCUMENT_URL' - возвращаются всегда.
FILTER	Массив вида `{"фильтруемое_поле": "значение фильтра" [, ...]}`. Список фильтруемых полей такой же, как для параметра `SELECT`. Перед названием фильтруемого поля может указать тип фильтрации: `"!"` - не равно; `"<"` - меньше; `"<="` - меньше либо равно; `">"` - больше; `">="` - больше либо равно.	Если в фильтре присутствует `USER_ID`, то проверяется субординация пользователей. Начальник может запросить список заданий своих подчиненных. Администратор может запрашивать все задания без ограничений.
ORDER	Массив для сортировки результата. Массив вида `{"поле_сортировки": 'направление сортировки' [, ...]}`. Список полей для сортировки такой же, как для параметра `SELECT`. Направление сортировки может принимать значения: `asc` - по возрастанию; `desc` - по убыванию.	`{'ID': 'desc'}`

Массив полей записей, которые будут возвращены методом. Можно указать только те поля, которые необходимы. Доступные поля:

ID - идентификатор задания;

WORKFLOW_ID - идентификатор бизнес-процесса;

DOCUMENT_NAME - название документа;

DESCRIPTION - описание задания;

NAME - название задания;

MODIFIED - дата изменения;

WORKFLOW_STARTED - дата запуска бизнес-процесса;

WORKFLOW_STARTED_BY - кем запущен бизнес-процесс;

OVERDUE_DATE - крайний срок;

WORKFLOW_TEMPLATE_ID - идентификатор шаблона бизнес-процесса;

WORKFLOW_TEMPLATE_NAME - название шаблона бизнес-процесса;

WORKFLOW_STATE - статус бизнес-процесса;

STATUS - статус задания:

0 - выполняется;
1 - утверждено (ответ Да);
2 - отклонено (ответ Нет);
3 - выполнено (ответ Ок);
4 - таймаут (истек срок выполнения задания).

USER_ID - идентификатор пользователя;

USER_STATUS - ответ пользователя:

0 - ожидание ответа;
1 - да (утвердил);
2 - нет (отклонил);
3 - ок (выполнил).

MODULE_ID - идентификатор модуля (по документу);

ENTITY - идентификатор сущности (по документу);

DOCUMENT_ID - идентификатор документа.

ACTIVITY - идентификатор типа задания, строка, варианты значений:

ApproveActivity - Утверждение документа
ReviewActivity - Ознакомление с документом
RequestInformationActivity - Запрос дополнительной информации
RequestInformationOptionalActivity - Запрос дополнительной информации (с отклонением)

ACTIVITY_NAME - идентификатор действия в шаблоне.

PARAMETERS - параметры задания, массив, который может содержать следующую информацию:

CommentLabelMessage - Название поля "Комментарий";
CommentRequired - Обязательность комментария. Допустимые значения N (нет), Y (да), YA (да при утверждении), YR (да при отклонении);
ShowComment - Показывать комментарий, Y/N;
TaskButtonMessage - текст кнопки "Ознакомлен";
TaskButton1Message - текст кнопки "Утвердить";
TaskButton2Message - текст кнопки "Отклонить";
Fields - массив с описанием полей ( с версии 20.0.800 С версии 20.0.800 модуля Бизнес-процессы появилась возможность выполнять задания Запрос доп.информации через rest метод bizrpoc.task.complete. Для того, чтобы понять, какие поля нужно заполнить, в метод bizproc.task.list в PARAMETERS добавлено новое свойство Fields. );

['ID', 'WORKFLOW_ID', 'DOCUMENT_NAME', 'NAME']

Важно: 'MODULE', 'ENTITY', 'DOCUMENT_ID', 'DOCUMENT_URL' - возвращаются всегда.

FILTER

Массив вида {"фильтруемое_поле": "значение фильтра" [, ...]}. Список фильтруемых полей такой же, как для параметра SELECT.

Перед названием фильтруемого поля может указать тип фильтрации:

"!" - не равно;
"<" - меньше;
"<=" - меньше либо равно;
">" - больше;
">=" - больше либо равно.

Если в фильтре присутствует USER_ID, то проверяется субординация пользователей. Начальник может запросить список заданий своих подчиненных. Администратор может запрашивать все задания без ограничений.

ORDER

Массив для сортировки результата. Массив вида {"поле_сортировки": 'направление сортировки' [, ...]}. Список полей для сортировки такой же, как для параметра SELECT.

Направление сортировки может принимать значения:

asc - по возрастанию;
desc - по убыванию.

{'ID': 'desc'}

Пример

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'
		],
		order: {ID: 'DESC'},
		filter: {'USER_ID': 1}
	},
	function(result)
	{
		if(result.error())
			alert("Error: " + result.error());
		else
			console.log(result.data());
	}
);