Получение настроек и данных раздела [Итоги]
Glossary Item Box
Общая информация
Функциональность получения настроек и данных по дашбордам реализована в сервисе AnalyticsService и в утилитном классе AnalyticsServiceUtils, пакет Platform.
AnalyticsService
Класс, реализующий сервис AnalyticsService, содержит следующие публичные методы:
- public Stream GetDashboardViewConfig(Guid id) — возвращает настройки представления и виджетов на вкладке итогов по идентификатору страницы итогов.
- public Stream GetDashboardData(Guid id, int timeZoneOffset) — возвращает данные по всем виджетам на вкладке итогов по идентификатору страницы итогов.
- public Stream GetDashboardItemData(Guid dashboardId, string itemName, int timeZoneOffset) — возвращает данные по определенному виджету по идентификатору страницы итогов и имени виджета.
Здесь timeZoneOffset — смещение (в минутах) часового пояса относительно UTC. Данные по итогам будут получены с использованием этого часового пояса.
Примеры запросов к сервису AnalyticsService
HEADERS
Accept:application/json
Метод GetDashboardViewConfig()
URL
POST /0/rest/AnalyticsService/GetDashboardViewConfig
Содержимое запроса
{
"id": "a71d5c04-dff7-4892-90e5-9e7cc2246915"
}
Содержимое ответа
{
"items": [
{
"layout": {
"column": 0,
"row": 0,
"colSpan": 12,
"rowSpan": 5
},
"name": "Chart4",
"itemType": 4,
"widgetType": "Chart"
}
]
}
Метод GetDashboardData()
URL
POST /0/rest/AnalyticsService/GetDashboardData
Содержимое запроса
{
"id": "a71d5c04-dff7-4892-90e5-9e7cc2246915",
"timeZoneOffset": 120
}
Содержимое ответа
{
"items": [
{
"name": "Indicator1",
"caption": "Среднее время выполнения активности",
"widgetType": "Indicator",
"style": "widget-green",
"data": 2
}
]
}
Метод GetDashboardItemData()
URL
POST /0/rest/AnalyticsService/GetDashboardItemData
Содержимое запроса
{
"dashboardId": "a71d5c04-dff7-4892-90e5-9e7cc2246915",
"itemName": "Chart4",
"timeZoneOffset": 120
}
Содержимое ответа
{
"name": "Chart4",
"caption": "Invoice payment dynamics",
"widgetType": "Chart",
"chartConfig": {
"xAxisDefaultCaption": null,
"yAxisDefaultCaption": null,
"seriesConfig": [
{
"type": "column",
"style": "widget-green",
"xAxis": {
"caption": null,
"dateTimeFormat": "Month;Year"
},
"yAxis": {
"caption": "Actually paid",
"dataValueType": 6
},
"schemaName": "Invoice",
"schemaCaption": "Invoice",
"useEmptyValue": null
}
],
"orderDirection": "asc"
},
"style": "widget-green",
"data": []
}
