| POST | /v1/reports | Retrieve Report by ReportName and Filters |
|---|
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
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardReportResult:
total_count: int = 0
report_result: Optional[List[Object]] = None
class ReportFilterType(str, Enum):
LIST = 'list'
LIST_LIKE = 'list_like'
DATE = 'date'
RANGE = 'range'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportFilter:
type: Optional[ReportFilterType] = None
values: Optional[List[str]] = None
start: Optional[datetime.datetime] = None
end: Optional[datetime.datetime] = None
higher_than: Optional[int] = None
lower_than: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportsPaging:
page: int = 0
page_size: int = 0
class ReportSortType(str, Enum):
ASC = 'asc'
DESC = 'desc'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardReportRequest(IPost):
# @ApiMember(Description="Report Name", IsRequired=true, ParameterType="body")
report_name: Optional[str] = None
"""
Report Name
"""
# @ApiMember(Description="Filters", IsRequired=true, ParameterType="body")
filters: Dict[str, ReportFilter] = field(default_factory=dict)
"""
Filters
"""
# @ApiMember(Description="Paging", ParameterType="body")
paging: Optional[ReportsPaging] = None
"""
Paging
"""
# @ApiMember(Description="Sorting", ParameterType="body")
sorting: Dict[str, ReportSortType] = field(default_factory=dict)
"""
Sorting
"""
Python DashboardReportRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/reports HTTP/1.1
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
reportName: String,
filters:
{
String:
{
type: list,
start: 0001-01-01,
end: 0001-01-01,
higherThan: 0,
lowerThan: 0
}
},
paging:
{
page: 0,
pageSize: 0
},
sorting:
{
String: asc
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
totalCount: 0
}