Структура запросов

Разбираем, как формируется строка запросов в Buildbox Workplace

Страницы Buildbox Workplace генерируются по заданным правилам, чтобы было удобно менять формат вывода без каких-либо дополнительных действий.

Структура обращения к Buildbox Workplace такова:

http(s)://домен/псевдоним/сервис/формат_вывода/обработчик/объект/опции

• домен - адрес ресурса
   
• псевдоним - дополнение к адресу, котороое может повторять часть адреса. Предназначено для размещения различных сервисов по одному доменному адресу.
  По-умолчанию дублирует первое слово доменного имени.
   
• сервис - (api/gui) - отдельный сервис, которые обрабатывает запросы.
  Buildbox Workplace - обрабатывается сервисом GUI. API - сервис доступа к базе данных Buildbox DataBase.
   
• формат_вывода - (list/view/modal/pdf/json/doc/pdfload/jsonload/docload), применим только для сервиса GUI (см.ниже)
  list - вывод как полноценная страница консоли
  view - HTML-страница в файле с использованием стилей консоли для вывода в отдельном окне
  modal - вывод чистого HTML для модальных окон и вставки в интерфейс (без стилей)
  pdf - вывод в PDF-файле (только для "обработчиков" - page, block)
  doc - вывод в формате Word  (только для "обработчиков" - page, block)
  json - вывод объекта в текстовом виде с заголовками json-документа (только для объекта (обработчик - obj, см.ниже)
  
  Для форматов pdf/json/doc существует два варианта просмотра результатов - открыть в браузере/скачать.
  Для скачивания используются следущие форматы_вывода
  pdfload - скачать файл в PDF-файле (только для "обработчиков" - page, block​​​​​​​)
  docload - скачать файл в формате Word (только для "обработчиков" - page, block​​​​​​​)
  jsonload - скачать файл объекта в текстовом виде с заголовками json-документа (только для объекта (обработчик - obj, см.ниже)
   
• обработчик - (page/column/obj/package/block)
  page - страница приложения Cockpit (см. ниже)
  package - пакет приложения Cockpit (см. ниже)
  block - блок приложения Cockpit (см. ниже)
  colunm - системная консоль работы с данными
  obj - вывод информации об объекте
   
• объект - все элементы вывода являются объектам, различные обработчики требуют для себя соответствующих объектов (например, чтобы обработчик page сгенерировал страницу, ему необходим объект страницы, который будет обработан исходи из логики "обработчика")
   
• опции - дополнительные условия для работы "обработчиков" (фильтрация и т.д.)
  Для форматов ist/view/modal/pdf/json/doc/text/pdfload/jsonload/docload/textload в качестве опции можно указать название файла, который будет открыт или в который будет сохранены данные.

Форматы вывода

Страницы, формы, объекты могут выводиться в трех различных режимах (внутри системы, как внешняя страница, в виде чистого html)

Все созданные в Buildbox Workplace элементы вывода информации (формы вывода, страницы, блоки, объекты) могут быть отражены в трех форматах вывода:

1. Внутренний вывод Buildbox Workplace - сгенерированный элемент вывода (страница, блок, форма, объект) выводится внутри рабочего пространства.
   В данном режиме ссылка запроса формируется так:
   
   http://ваш_ресурс/gui/list/..... - 
    
2. Внешний вывод Buildbox Workplace - сгенерированный элемент вывода (страница, форма, объект) выводится на отдельной странице вне рабочего пространства, но наследует стили и методы. В такой режиме вывода работают "Внешние формы" для внесения данных пользователями вне системы Buildbox Workplace.
   
   http://ваш_ресурс/gui/view/..... -
    
3. Вывод чистого HTML-кода элемента вывода - выводится без применения каких-либо стилей. Используется для всплывающий форм и интеграции в сторонние сайты.
   
   http://ваш_ресурс/gui/modal/..... -