Перейти к основному содержимому
Версия: 8.3

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

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

GetTemplates

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      PagingStruct:PagingModelМодель постраничного запросаСвязь
    • Outputs

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

GetReportBasicInfoById

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ReportIdGuidИдентификатор отчетаСвязь
    • Outputs

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

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

GenerateAvailabilityReport

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      NameStringНазвание отчетаСвязь
      DescriptionStringОписаниеСвязь
      TemplateIdInteger64Идентификатор шаблона используемого для генерацииСвязь
      RangeStruct:DataRangeПериод для расчетаСвязь
      ExpirationTimeDoubleВремя хранения отчетаСвязь
      ParamsStruct:AvailabilityReportParamsМодель настроек отчетаСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ReportIdGuidИдентификатор отчетаСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

GenerateMultiAvailabilityReport

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      NameStringНазвание мультиотчетаСвязь
      DescriptionStringОписаниеСвязь
      TemplateIdInteger64Идентификатор шаблона используемого для генерацииСвязь
      RangeStruct:DataRangeПериод для расчетаСвязь
      ExpirationTimeDoubleВремя хранения мультиотчетаСвязь
      ParamsStruct:AvailabilityReportParamsМодель настроек мультиотчетаСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ReportIdGuidИдентификатор мультиотчетаСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

GetAvailabilityReportResult

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ReportIdGuidИдентификатор отчетаСвязь
      TimeZoneStringЧасовой пояс. Пример: Europe/Moscow, Europe/Berlin, Asia/ShanghaiСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ReportResultStruct:ReportAvailabilityResultОтчет в формате JsonСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

GetConfigItemAvailabilityReportResult

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ReportIdGuidИдентификатор отчетаСвязь
      ConfigItemIdInteger64Идентификатор КЕСвязь
      TimeZoneStringЧасовой пояс. Пример: Europe/Moscow, Europe/Berlin, Asia/ShanghaiСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ReportResultStruct:ReportConfigItemAvailabilityResultОтчет по КЕ в формате JsonСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

GetMultiAvailabilityReportResult

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ReportIdGuidИдентификатор мультиотчетаСвязь
      TimeZoneStringЧасовой пояс. Пример: Europe/Moscow, Europe/Berlin, Asia/ShanghaiСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ReportResultStruct:ReportMultiAvailabilityResultМультиотчет в формате JsonСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь