Кнопка отправки HTTP-запросов - Продукт Modus BI
«Кнопка» является модификацией визуального компонента «Панель закладок».
- Позволяет отправлять http-запросы.
- Поддерживает методы:
POST
;GET
;PUT
;PATCH
;DELETE
.
- Предусмотрена возможность использовать значения фильтров в качестве параметров запроса.
- Предусмотрена кнопка подтверждения отправки запроса с возможностью отправки текстового комментария.
Настройка элемента
Выберите в настройках отчета визуальный компонент «Панель закладок» и перейдите в раздел «Действие кнопки».
- Выберите из выпадающего списка «Отправка запроса».
- Выберите тип запроса.
- Включите флаг «Подтверждение при отправке».
- Добавьте URL — строка адреса, на который отправляется запрос API. Пример:
https://api.telegram.org/bot{token}/{method}
- Заголовок запроса — позволяет клиенту и серверу отправлять дополнительную информацию. Пример заголовков:
[ { "key":"Content-Type", "val":"application/json; charset=utf-8" }, { "key":"Accept-Encoding", "val":"identity" } ]
- Тело запроса — заполняется данными, которые необходимо отправить в запросе. Пример тела запроса:
{
"startDate": "2020-12-31",
"endDate": "2023-01-14",
"comment" : "Комментарий"
}
После завершения настроек нажмите на кнопку «Сохранить».
Значения фильтров в качестве параметров запроса
В качестве параметров запроса также можно использовать значения фильтров. Для ссылки на фильтр укажите его наименование в двойных фигурных скобках: {{Фильтр.Наименование Фильтра}}
- Если изменяемый параметр должен быть в строке URL, добавьте ссылку на фильтр непосредственно в URL:
https://api.telegram.org/bot{{Фильтр.Наименование Фильтра 1}}/{{Фильтр.Наименование Фильтра 2}}
- Если изменяемый параметр должен быть в заголовках или теле запроса, ссылка на фильтр добавляется к значению ключа:
{
"val_1": "{{Фильтр.Округ}}",
"val_2": "{{Фильтр.Дата}}"
}
-
Ели значение параметра даты требует форматирования, используйте маску даты. Для этого после ссылки на фильтр добавьте символ
>>
, затем в квадратных скобках укажите формат даты.
Подробнее о форматах даты: Microsoft Docs.
Пример:
"val_3": "{{Фильтр.Дата>>[DD.MM.YYYY]}}"
"val_4": "{{Фильтр.Дата>>[YYYY-MM-DD]}}"
"val_5": "{{Фильтр.Дата>>[DD.MM.YYYY HH:mm:ss]}}"
- Если значение параметра даты представляет собой период (начало и конец), добавьте соответствующий признак (
Начало
илиОкончание
) через точку:
Пример:
"val_6": "{{Фильтр.Дата.Начало}}"
"val_7": "{{Фильтр.Дата.Окончание]}}"
Подтверждение отправки запроса
Чтобы избежать случайных нажатий, используется механизм подтверждения отправки запроса, который активируется соответствующим флагом.
Дополнительно можно включить опцию «Комментарий». Он интегрируется в тело запроса с помощью ссылки на поле {{comment}}
.
Пример:
"val_6": "{{Фильтр.Дата.Начало}}"
"val_7": "{{Фильтр.Дата.Окончание]}}"
"val_8": "{{comment}}"
Пример использования связки Аналитический портал — Modus ETL
Для интеграции аналитического портала и Modus ETL в последнем должны быть произведены настройки позволяющие принимать HTTP-запросы.
В Modus ETL также необходимо добавить учетную запись с правами администратора, которая позволит производить запуск составов выгрузки, сценариев и пакетов непосредственно из аналитического портала.
В URL для отправки запросов необходимо добавить учетные данные ETL, затем через @ адрес сервера, где развернут ETL:
http://[login]:[password]@[Адрес публикации]/hs/object/run
Подробнее о настройке и примеры запуска объектов в разделе «API для запуска пакетов, составов, сценариев».