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

Процессы

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

Подробнее о процессах можно прочитать в документации по модулю rpa

rpa.type.*

Метод Описание С версии
rpa.type.get({id: number}) Отдает информацию о процессе по его ID. Параметр:
  • id - ID процесса

Ответ:
{
	"type": {
		"id":1,
		"title":"Название процесса",
		"image":"list",
		"createdBy":1,
		"settings":[],
		"permissions":[
			{
				"id":"1",
				"entity":"TYPE",
				"entityId":"1",
				"accessCode":"UA",
				"action":"ITEMS_CREATE",
				"permission":"X"
			}
		]
	}
}
  • title - название процесса
  • image - это идентификатор иконки из списка
  • createdBy - идентификатор пользователя, который создал процесс
  • settings - набор настроек процесса
  • permissions - набор настроек прав доступа этого процесса
rpa.type.list({select: ?[] = ['*'], order: ?{} = null, filter: ?{} = null, start: ?number = 0}) Метод вернет массив процессов с их полями.
{
	"types": [
		{},
		{}
	]
}
Параметры:
  • select - массив полей для вывода. По умолчанию выводятся все
  • order - список для сортировки, где ключ - поле, а значение - ASC или DESC
  • filter - список для фильтрации
  • start - сдвиг для постраничной навигации
rpa.type.add({fields: {}}) Метод создаст новый процесс и вернет в ответе данные, аналогичные ответу на запрос rpa.type.get. fields - список с полями процесса:
  • fields[title] - название процесса (обязательное)
  • fields[image] - изображение процесса из списка
  • fields[settings] - список с произвольным набором настроек процесса
  • fields[permissions] - массив с правами доступа к этому процессу

Важно! Автоматические сценарии (создание стадий, роботов и полей по умолчанию) не будут запущены при создании процесса через rest.

Важно! В запросе обязательно должны быть указаны права доступа на изменение процесса


Пример запроса

Этот запрос создаст новый процесс под названием "Мой процесс". Все пользователи смогут создавать элементы этого процесса. Только пользователь с ID 1 сможет менять настройки этого процесса

{
	"fields": {
		"title": "Мой процесс",
		"image": "list",
		"permissions": [
			{
				"accessCode": "UA",
				"permission": "X",
				"action": "ITEMS_CREATE"
			},
			{
				"accessCode": "U1",
				"permission": "X",
				"action": "MODIFY"
			},
		]
	}
}
rpa.type.update({id: number, fields: {}}) Метод обновит процесс с id и вернет в ответе данные, аналогичные ответу на запрос rpa.type.get. Параметры:
  • id - идентификатор процесса
  • fields - список с полями процесса. Полностью аналогичен набору из метода rpa.type.add
rpa.type.delete({id: number}) Метод удаляет процесс. Параметры:
  • id - идентификатор процесса
© «Битрикс», 2001-2024, «1С-Битрикс», 2024