Контракты отчетов. СПИК
- 1 Контракт данных SpicReportInfo
- 2 Контракт данных SpicReportInfoCollection
- 3 Контракт данных SpicReportRequest
- 4 Контракт данных SpicReportTargetCardinality
- 5 Контракт данных SpicReportTargetType
- 6 Контракт данных SpicReportTemplateInfo
- 7 Контракт данных SpicSchedulingReportFormat
Контракт данных SpicReportInfo
// Основная информация об отчете
SpicReportInfo
{
// Идентификатор отчета
Guid Id
// Название отчета
string Title
// Описание отчета
string Description
}
Контракт данных SpicReportInfoCollection
// Все доступные отчеты и шаблоны.
SpicReportInfoCollection
{
// Информация об отчетах
SpicReportInfo[] ReportInfos
// Информация о шаблонах отчетов
SpicReportTemplateInfo[] TemplateInfos
}
Контракт данных SpicReportRequest
// Запрос отчета
SpicReportRequest
{
// Идентификатор шаблона отчета
Guid ReportTemplateId
// Идентификатор отчета
Guid ReportType
// Тип объекта, по которому будет построен отчет
SpicReportTargetType ReportTargetType
// Параметр, показывающий, по одному или по нескольким объектам должен быть построен отчет
SpicReportTargetCardinality ReportTargetCardinalityType
// Идентификаторы объектов, по которым необходимо построить отчет
int[] Targets
// Начальная дата для построения отчета
DateTime BeginDateTime
// Конечная дана для построения отчета
DateTime EndDateTime
// Адреса электронной почты, на которые будет разослан построенный отчет
string[] Emails
// Формат файла отчета
SpicSchedulingReportFormat OutputFormat
}
Контракт данных SpicReportTargetCardinality
// Показывает размерность отчета
SpicReportTargetCardinality
{
string Value
}
Параметр Value может принимать следующие значения:
- None – не установлено
- One – отчет, который может строится по одной машине.
- Many – Отчет, который может быть построен по нескольким машинам.
Контракт данных SpicReportTargetType
// Показывает, по какому типу объекта нужно построить отчет
SpicReportTargetType
{
string Value
}
Параметр Value может принимать следующие значения:
- Unknown
- Unit – По Объектам Мониторинга.
- Driver – По водителям(только в плагинах)
- Company – По компаниям(только в плагинах)
Контракт данных SpicReportTemplateInfo
// Основная информация о шаблоне отчета
SpicReportTemplateInfo
{
// Идентификатор шаблона отчета
Guid Id
// Идентификатор отчета, которому принадлежит этот шаблон
Guid ReportId
// Название шаблона отчета
string Title
}
Контракт данных SpicSchedulingReportFormat
// Показывает формат файла отчета
SpicReportTargetType
{
string Value
}
Параметр Value может принимать следующие значения:
- Unknown
- CSV