| Required role: | TenantReader |
| GET | /api/statistics/summary | Gets statistics like Resources by OsTypes, etc. | |
|---|---|---|---|
| GET | /statistics/summary | Gets statistics like Resources by OsTypes, etc. |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')
class StatisticsDataType(str, Enum):
SINGLE_DATAPOINT = 'SingleDatapoint'
SINGLE_DATASET = 'SingleDataset'
MULTI_DATASET = 'MultiDataset'
class IStatisticsData:
name: Optional[str] = None
type: Optional[StatisticsDataType] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StatisticsSummaryDto:
generated_on: datetime.datetime = datetime.datetime(1, 1, 1)
statistics: Dict[str, IStatisticsData] = field(default_factory=dict)
# @Api(Description="Gets statistic like Resources by OsTypes, etc.")
# @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(StatisticsSummaryDto), StatusCode=200)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetStatisticsSummary(IBaseRequest, IHasTenantName, IGet):
"""
Gets statistic like Resources by OsTypes, etc.
"""
# @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
# @Validate(Validator="NotEmpty")
tenant_name: Optional[str] = None
Python 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}}