Конфигурация публикации определяет название и активность объекта, а также параметры запросов (Post или Get).
Конфигурация публикации. Состав полей зависит от типа объекта и типа запроса.
Параметр |
Описание |
|---|---|
Описание |
Описание объекта в свободной форме. Желательно, чтобы описание отображало смысл объекта |
Алиас |
Уникальное название объекта (задается в свободной форме) |
Тип публикации |
Возможные значения: •Sql-view •Пакет действий |
Тип запроса |
Для SQL View доступен только метод Get, для пакетов действий — методы Get, Post, Put и Delete |
Тип содержимого |
(только для запросов с типом Post) Возможные значения: •application/json •application/xml •application/x-www-form-urlencoded •multipart/form-data •plain text •text/xml |
Параметры запроса |
Передаваемые параметры необходимо задать в таблице. См. ниже |
URL |
Формируются автоматически на основании конфигураций публикации и объекта доступа. Для SQL View формируются два URL для форматов csv и xml |
Активность публикации |
При включенном флажке объект считается опубликованным и доступным для использования из внешних систем. При обращении к объекту с отключенной активностью публикации возвращается ошибка 403 |
Объект |
Имя сохраненного SQL View в базе данных или название общего смарт-пакета с включенным флажком "Для публикаций". Обратите внимание на особенности публикуемых смарт-пакетов |
XSLT схема |
(только для SQL View) Указывается, если для запроса SQL View нужно определить схему для XSLT-преобразований. См. ниже |
Столбец |
Значение |
|
|---|---|---|
Тип параметра |
Для методов Get, Put и Delete используется тип QueryString, а для метода Post — QueryString и RequestBody (параметр RequestBody может содержать любые входящие и исходящие параметры)
|
|
Ключ параметра |
Имя параметра |
|
Валидация параметра |
Возможные варианты: •Строка •Число с плавающей точкой •Целое число •Дата |
|
Обязательность параметра |
Если флажок включен, то параметр обязателен. Если в запрос не передан какой-то из обязательных параметров, то в качестве результата запроса возвращается bad request |
|
Формат даты |
Формат даты в виде строки вида dd.MM.yyyy. См. здесь Параметр задается только если в колонке "Валидация параметра" выбрано значение "Дата" |
|
Массив |
Возможные варианты: •Нет •Строка с разделителем. В этом случае в качестве параметра должна передаваться строка вида item1#item2#item3, где # — символ-разделитель (задается в параметре "Разделитель массива") •Массив JSON. В этом случае в качестве параметра должна передаваться строка вида ["item1", "item2", "item3"] |
|
Разделитель массива |
Символ разделителя в массиве (например, запятая). Параметр задается только если в колонке "Массив" выбрано значение "Строка с разделителем" |
В SQL View параметры не используются Особенности публикуемых смарт-пакетов
|
|---|
В смарт-выражения, которые создаются в этом смарт-пакете, передается параметр @eventParam0. Он содержит строку в формате JSON со всеми параметрами запроса.
Параметры запроса в публикации.
Обращаться к значениям этих параметров можно через функцию JSON_VALUE:
JSON_VALUE(@eventParam0, '$.queryString.paramName')
См. пример в Методическом руководстве администратора.
Формирование тела ответа и кода ответа с помощью скрипта
Если в рамках публикации выполняется сложный высоконагруженный скрипт, который должен возвращать не только сам результат, но и признак успешности выполнения, используйте в публикуемом пакете два смарт-действия:
•сначала "Выполнить sql скрипт" (раздел "Прочее") — в нем можно сформировать выражение формата JSON, которое будет содержать и тело ответа, и код ответа
•затем "HTTP-ответ", в котором можно обратиться к результату предыдущего действия и получить подготовленные тело ответа и код ответа.
Таким образом, скрипт не придется выполнять дважды.
Схема XSLT используется для преобразования данных в определенный XML формат, соответствующий потребностям какой-либо внешней системы.
Например, представление SQL View может содержать данные для отображения на сайте компании в каталоге товаров. Те же данные могут использоваться и для внутренней аналитики в Excel, и для выгрузки в учетную систему. В этом случае удобно для SQL View создать один или несколько шаблонов для преобразования данных в соответствующие форматы.
Правила формирования схемы XSLT можно посмотреть здесь.
Если схема настроена, то при выгрузке XML производится трансформация по этому шаблону.
|
|---|
Полезные ссылки
Использование опубликованных SQL View
