| POST | /v1/reports/Csv | Retrieve Report by ReportName and Filters and return as CSV |
|---|
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 DashboardCsvReportsRequest = 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,
};
Zig DashboardCsvReportsRequest 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/Csv 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
}
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
totalCount: 0
}