| Required role: | TenantReader |
| GET | /api/statistics/summary | Gets statistics like Resources by OsTypes, etc. | |
|---|---|---|---|
| GET | /statistics/summary | Gets statistics like Resources by OsTypes, etc. |
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CoreService.ServiceModel.Dtos.Statistics.Crud
Imports CoreService.ServiceModel.Dtos.Statistics.Responses
Imports CoreService.ServiceModel.Interfaces
Imports CoreService.ServiceModel.Enums
Namespace Global
Namespace CoreService.ServiceModel.Dtos.Statistics.Crud
'''<Summary>
'''Gets statistic like Resources by OsTypes, etc.
'''</Summary>
<Api(Description:="Gets statistic like Resources by OsTypes, etc.")>
<ApiResponse(Description:="Success", IsDefaultResponse:=true, ResponseType:=GetType(StatisticsSummaryDto), StatusCode:=200)>
Public Partial Class GetStatisticsSummary
Implements IBaseRequest
Implements IHasTenantName
Implements IGet
<ApiMember(DataType:="string", IsRequired:=true, ParameterType:="header")>
<Validate(Validator:="NotEmpty")>
Public Overridable Property TenantName As String Implements IHasTenantName.TenantName
End Class
End Namespace
Namespace CoreService.ServiceModel.Dtos.Statistics.Responses
Public Partial Class StatisticsSummaryDto
Public Overridable Property GeneratedOn As Date
Public Overridable Property Statistics As Dictionary(Of String, IStatisticsData) = New Dictionary(Of String, IStatisticsData)
End Class
End Namespace
Namespace CoreService.ServiceModel.Enums
Public Enum StatisticsDataType
SingleDatapoint
SingleDataset
MultiDataset
End Enum
End Namespace
Namespace CoreService.ServiceModel.Interfaces
Public Interface IStatisticsData
Property Name As String
Property Type As StatisticsDataType
End Interface
End Namespace
End Namespace
VB.NET GetStatisticsSummary DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/statistics/summary HTTP/1.1 Host: core.starburst.svc Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"generatedOn":"0001-01-01T00:00:00.0000000Z","statistics":{"String":null}}