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

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

GetTemplates

• Назначение: Получение списка шаблонов всех типов отчетов

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

  • Inputs

    Название	Тип	Описание	Параметры
    In	Exec	Пин вызова	Связь
    Scenario	Struct:ScenarioBase	Системная переменная	Связь
    BearerToken	String	По умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
    Paging	Struct:PagingModel	Модель постраничного запроса	Связь

  • Outputs

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

---

GetReportBasicInfoById

• Назначение: Получение отчета любого типа по его идентификатору

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

  • Inputs

    Название	Тип	Описание	Параметры
    In	Exec	Пин вызова	Связь
    Scenario	Struct:ScenarioBase	Системная переменная	Связь
    BearerToken	String	По умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
    ReportId	Guid	Идентификатор отчета	Связь

  • Outputs

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

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

GenerateAvailabilityReport

• Назначение: Генерация отчета доступности

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

  • Inputs

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

  • Outputs

    Название	Тип	Описание	Параметры
    Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
    Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
    ReportId	Guid	Идентификатор отчета	Связь
    Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

---

GenerateMultiAvailabilityReport

• Назначение: Генерация мультиотчета доступности

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

  • Inputs

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

  • Outputs

    Название	Тип	Описание	Параметры
    Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
    Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
    ReportId	Guid	Идентификатор мультиотчета	Связь
    Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

---

GetAvailabilityReportResult

• Назначение: Получение результатов расчета отчета доступности

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

  • Inputs

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

  • Outputs

    Название	Тип	Описание	Параметры
    Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
    Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
    ReportResult	Struct:ReportAvailabilityResult	Отчет в формате Json	Связь
    Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

---

GetConfigItemAvailabilityReportResult

• Назначение: Получение результатов расчета отчета доступности по выбранной КЕ

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

  • Inputs

    Название	Тип	Описание	Параметры
    In	Exec	Пин вызова	Связь
    Scenario	Struct:ScenarioBase	Системная переменная	Связь
    BearerToken	String	По умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
    ReportId	Guid	Идентификатор отчета	Связь
    ConfigItemId	Integer64	Идентификатор КЕ	Связь
    TimeZone	String	Часовой пояс. Пример: Europe/Moscow, Europe/Berlin, Asia/Shanghai	Связь

  • Outputs

    Название	Тип	Описание	Параметры
    Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
    Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
    ReportResult	Struct:ReportConfigItemAvailabilityResult	Отчет по КЕ в формате Json	Связь
    Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

---

GetMultiAvailabilityReportResult

• Назначение: Получение результатов расчета мультиотчета доступности

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

  • Inputs

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

  • Outputs

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