bizproc.robot.add

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

Описание

bizproc.robot.add - метод регистрирует нового робота.

Параметры

Параметр	Описание
CODE	Внутренний идентификатор робота. Допустимые символы a-z, A-Z, 0-9, точка, дефис и нижнее подчеркивание. Обязательный параметр.
HANDLER	URL приложения, на который будут отправлены данные. Обязательный параметр.
AUTH_USER_ID	ID пользователя, токен которого будет передан приложению.
NAME	Название робота. Может быть строкой или ассоциативным массивом локализированных строк. Обязательный параметр.
USE_SUBSCRIPTION	Использование подписки. Допустимые значения - Y или N. Можно указать, должен ли робот ожидать ответа от приложения. Если параметр пустой или не указан - пользователь может сам настроить этот параметр в настройках действия в дизайнере бизнес-процессов.
PROPERTIES	Массив параметров робота. Список значений аналогичен значениям параметра RETURN_PROPERTIES.
USE_PLACEMENT	Дает возможность открывать дополнительные настройки робота в слайдере приложения. Принимает значения (Y/N). Необязательный параметр.
PLACEMENT_HANDLER	URL встройки (обработчик встройки на стороне приложения). Если использовать параметр USE_PLACEMENT со значением "Y", но не указать PLACEMENT_HANDLER, то возникает ошибка `"error": "ERROR_WRONG_HANDLER_URL", "error_description": "Wrong handler URL"` .
RETURN_PROPERTIES	Массив возвращаемых значений робота. Параметр управляет возможностью ожидать ответа приложения роботом и работать с данными, которые придут в ответе. Внимание! Системное название параметра должно начинаться с буквы и может содержать только символы a-z, A-Z, 0-9 и нижнее подчеркивание. Каждый параметр обязательно должен содержать: Name - строка или массив локализаций. Description - описание параметра, строка или массив локализаций. Type - тип параметра. Список базовых параметров: `bool` (Да/Нет) `date` (Дата) `datetime` (Дата/Время) `double` (Число) `int` (Целое число) `select` (Список) массив значений списка: `string` (Строка) `text` (Текст) `user` (Пользователь) Options Только для TYPE равному select. [ 'value1' => 'title1', 'value2' => 'title2', 'value3' => 'title3', 'value4' => 'title4', ] Required(Y/N) - обязательность параметра. Multiple(Y/N) - множественность параметра. Default - значение параметра по-умолчанию. По умолчанию тип параметра - string, необязательный, немножественный.

Пример

var params = {
	'CODE': 'robot',
	'HANDLER': 'http:///robot.php',
	'AUTH_USER_ID': 1,
	'NAME': 'Пример робота',
	'PROPERTIES': {
		'bool': {
			'Name': 'Да/Нет',
			'Type': 'bool',
			'Required': 'Y',
			'Multiple': 'N'
		},
		'date': {
			'Name': 'Дата',
			'Type': 'date'
		},
		'datetime': {
			'Name': 'Дата/Время',
			'Type': 'datetime'
		},
		'double': {
			'Name': 'Число',
			'Type': 'double',
			'Required': 'Y'
		},
		'int': {
			'Name': 'Целое число',
			'Type': 'int'
		},
		'select': {
			'Name': 'Список',
			'Type': 'select',
			'Options': {
				'one': 'one',
				'two': 'two'
			}
		},
		'string': {
			'Name': 'Строка',
			'Type': 'string',
			'Default': 'default string value'
		},
		'text': {
			'Name': 'Текст',
			'Type': 'text'
		},
		'user': {
			'Name': 'Пользователь',
			'Type': 'user'
		}
	}
};
BX24.callMethod(
	'bizproc.robot.add',
	params,
	function(result)
	{
		if(result.error())
			alert("Error: " + result.error());
		else
			alert("Успешно: " + result.data());
	}
);