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 и нижнее подчеркивание.
Каждый параметр обязательно должен содержать:
|
Пример
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());
}
);
Сообщение не промодерировано, возможны ошибки и неточности.
|
|
RETURN_PROPERTIES - для возвращения результата из локального приложеня в робот используйте метод
'bizproc.event.send' |
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Пользовательские комментарии
Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.Для этого нужно всего лишь авторизоваться на сайте
Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.
Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.