Запуск пакетов, составов, сценариев используя API

В Modus ETL реализован API в виде http-сервиса для запуска Составов выгрузки, Сценариев, Пакетов обработки данных.

Публикация на веб-сервере

Для работы сервиса необходимо выполнить его публикацию на веб-сервере.

Инструкции для публикации информационной базы на веб-сервере доступны в руководстве администратора на сайте Информационно-технологического сопровождения 1C.

См. также Инструкция публикации IIS на инфостарт.

Для публикации сервиса необходимо:

1. В режиме конфигуратора перейти: «Администрирование» / «Публикация на веб. сервере…».
2. В открывшемся окне выбрать вкладку http-сервисы, и установить флаг напротив сервиса «хс_ЗапускОбъектов».
3. Сохранить настройки и перезагрузить веб-сервер.

Запуск объектов

Для запуска объекта необходимо отправить 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 выводится в форме пакета обработки данных.