Функции для работы с отчетами

Общие параметры для функций

Входящие пины

• In
  Тип: exec
  Описание: Пин вызова функции и передачи в нее управления
• BearerToken
  По умолчанию BearerToken запрашивается из системной переменной Scenario.
  Если указать вручную, в запросе к API будет применен указанный токен.

Исходящие пины

• Ok
  Тип: exec
  Описание: Последовательность продолжается по этой ветке в случае успешного выполнения запроса
• Failed
  Тип: exec
  Описание: Последовательность продолжается по этой ветке если запрос выполнен с ошибкой
• Response
  Тип: Struct:AutomatonResponse
  Описание: Возвращает результат выполнения запроса в виде данных со структурой модели AutomatonResponse

---

Общие функции отчетов

GetTemplates

Назначение: Получение списка шаблонов всех типов отчетов
Описание: Функция позволяет получить список шаблонов всех типов отчетов, кол-во имеющихся отчетов по шаблону и информацию о последнем рассчитанном.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
Paging	Struct:PagingModel	Модель постраничного запроса

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Templates	Struct:Template (array)	Общая информация о всех шаблонах, всех типов отчетов в системе

GetReportBasicInfoById

Назначение: Получение отчета любого типа по его идентификатору
Описание: Функция позволяет получить конкретно заданный отчет любого типа по его идентификатору.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
ReportId	Guid	Идентификатор отчета

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Report	Struct:Report	Базовая информация об отчете (без данных)

---

Функции отчетов Доступности

GenerateAvailabilityReport

Назначение: Генерация отчета доступности
Описание: Функция реализует запрос к API на генерацию отчета о доступности по шаблону.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
Name	String	Название отчета
Description	String	Описание
TemplateId	Integer64	Идентификатор шаблона используемого для генерации
Range	Struct:DataRange	Период для расчета
ExpirationTime	Double	Время хранения отчета
Params	Struct:AvailabilityReportParams	Модель настроек отчета

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
ReportId	Guid	Идентификатор отчета

GenerateMultiAvailabilityReport

Назначение: Генерация мультиотчета доступности
Описание: Функция реализует запрос к API на генерацию мультиотчета о доступности по шаблону.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
Name	String	Название мультиотчета
Description	String	Описание
TemplateId	Integer64	Идентификатор шаблона используемого для генерации
Range	Struct:DataRange	Период для расчета
ExpirationTime	Double	Время хранения мультиотчета
Params	Struct:AvailabilityReportParams	Модель настроек мультиотчета

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
ReportId	Guid	Идентификатор мультиотчета

GetAvailabilityReportResult

Назначение: Получение результатов расчета отчета доступности
Описание: Функция реализует запрос к API на получение результатов расчета отчета доступности.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
ReportId	Guid	Идентификатор отчета
TimeZone	String	Часовой пояс. Пример: Europe/Moscow, Europe/Berlin, Asia/Shanghai

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
ReportResult	Struct:ReportAvailabilityResult	Отчет в формате Json

GetConfigItemAvailabilityReportResult

Назначение: Получение результатов расчета отчета доступности по выбранной КЕ
Описание: Функция реализует запрос к API на получение результатов расчета отчета доступности по выбранной КЕ.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
ReportId	Guid	Идентификатор отчета
ConfigItemId	Integer64	Идентификатор КЕ
TimeZone	String	Часовой пояс. Пример: Europe/Moscow, Europe/Berlin, Asia/Shanghai

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
ReportResult	Struct:ReportConfigItemAvailabilityResult	Отчет по КЕ в формате Json

GetMultiAvailabilityReportResult

Назначение: Получение результатов расчета мультиотчета доступности
Описание: Функция реализует запрос к API на получение результатов расчета мультиотчета доступности.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
ReportId	Guid	Идентификатор мультиотчета
TimeZone	String	Часовой пояс. Пример: Europe/Moscow, Europe/Berlin, Asia/Shanghai

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
ReportResult	Struct:ReportMultiAvailabilityResult	Мультиотчет в формате Json