API для запуска пакетов, составов, сценариев - Продукт Modus BI
В Modus ETL реализован API в виде http-сервиса для запуска Составов выгрузки, Сценариев, Пакетов обработки данных.
Публикация на веб-сервере
Для работы сервиса необходимо выполнить его публикацию на веб-сервере.
Инструкции для публикации информационной базы на веб-сервере доступны в руководстве администратора на сайте Информационно-технологического сопровождения 1C.
Смотрите также «Пошаговая инструкция настройки web-сервисов для 1Сv8.3 и IIS 8.5» : infostart.ru/1c/articles/275820/.
Для публикации сервиса выполните шаги:
- Перейдите в режим конфигуратора.
- Перейдите в раздел «Администрирование/ Публикация на веб. сервере…».
- В открывшемся окне выберите вкладку http-сервисы, и установите галочку напротив сервиса «хс_ЗапускОбъектов».
- Сохраните настройки и перезагрузите веб-сервер.
Запуск объектов
Для запуска объекта отправьте HTTP-запрос на адрес «/object/run». Убедитесь, что пользователь, выполняющий запрос, обладает ролью «Запуск объектов». При успешном запуске сервис вернет код состояния 200 и текстовое сообщение об успешном выполнении. В случае ошибки сервис вернет текстовое сообщение с описанием проблемы.
Проверьте журнал регистрации для просмотра действий сервиса. Укажите имя области «Запуск объектов через сервис» для поиска соответствующих записей.
Пример JSON для запуска состава выгрузки
{
"object": "composition",
"uuid": "00000000-0000-0000-0000-000000000000",
"parameters": [
{
"parameterName": "name",
"parameterValue": "value",
"parameterType": "date",
"packageNumber": 1},
{
"parameterName": "name",
"parameterValue": "valule",
"packageNumber": 1},
]
}
Параметры object и uuid обязательны для заполнения, uuid выводится в форме состава выгрузки. Параметр parameterType
должен принимать значение date
, если передается параметра типа Дата.
Пример JSON для запуска сценария
{
"object": "scenario",
"uuid": "00000000-0000-0000-0000-000000000000",
"parameters": [
{
"parameterName": "name",
"parameterValue": "value",
"parameterType": "date",
}
]
}
Параметры object
и uuid
обязательны для заполнения. uuid
выводится в форме сценария. Параметр parameterType
должен принимать значение date
, если передается параметра типа Дата.
Пример JSON для запуска пакета обработки данных
{
"object": "package",
"uuid": "00000000-0000-0000-0000-000000000000"
}
Оба параметра обязательны. uuid
выводится в форме пакета обработки данных.