Документация для разработчиков
Темная тема

bizproc.workflow.instances

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

Описание и пример

bizproc.workflow.instances - метод возвращает список запущенных бизнес-процессов.

Важно: метод доступен только администратору.

Пример

BX24.callMethod(
	'bizproc.workflow.instances',
	{
		select: ['ID', 'MODIFIED', 'OWNED_UNTIL', 'MODULE_ID', 'ENTITY', 'DOCUMENT_ID', 'STARTED', 'STARTED_BY', 'TEMPLATE_ID'],
		order: {STARTED: 'DESC'},
		filter: {'>STARTED_BY': 0}
	},
	function(result)
	{
		if(result.error())
			alert("Error: " + result.error());
		else
			console.log(result.data());
	}
);

Параметры

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

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

Доступные поля:

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

OWNED_UNTIL - время блокировки бизнес-процесса. Процесс считается зависшим, если разница времени блокировки с текущим временем более 5 минут;

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

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

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

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

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

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

['ID', 'MODIFIED', 'OWNED_UNTIL']

FILTER

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

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

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

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

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

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

{'MODIFIED': 'desc'}



Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024