| POST | /v1/reports | Retrieve Report by ReportName and Filters |
|---|
const std = @import("std");
pub const DashboardReportResult = struct {
totalCount: i32 = 0,
reportResult: []std.json.Value = &.{},
};
pub const ReportFilterType = enum {
list,
list_like,
date,
range,
};
pub const ReportFilter = struct {
type: ?ReportFilterType = null,
values: [][]const u8 = &.{},
start: ?[]const u8 = null,
end: ?[]const u8 = null,
higherThan: ?i32 = null,
lowerThan: ?i32 = null,
};
pub const ReportsPaging = struct {
page: i32 = 0,
pageSize: i32 = 0,
};
pub const ReportSortType = enum {
asc,
desc,
};
pub const DashboardReportRequest = struct {
/// Report Name
// @ApiMember(Description="Report Name", IsRequired=true, ParameterType="body")
reportName: ?[]const u8 = null,
/// Filters
// @ApiMember(Description="Filters", IsRequired=true, ParameterType="body")
filters: ?std.json.Value = null,
/// Paging
// @ApiMember(Description="Paging", ParameterType="body")
paging: ?ReportsPaging = null,
/// Sorting
// @ApiMember(Description="Sorting", ParameterType="body")
sorting: ?std.json.Value = null,
};
Zig DashboardReportRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"reportName":"String","filters":{"String":{"type":"list","start":"\/Date(-62135596800000-0000)\/","end":"\/Date(-62135596800000-0000)\/","higherThan":0,"lowerThan":0}},"paging":{"page":0,"pageSize":0},"sorting":{"String":"asc"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"totalCount":0}