| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/report/export |
|---|
import Foundation
import ServiceStack
public class ReportExportRequest : ReportDefinition
{
public var format:String
public var title:String
public var fileName:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case format
case title
case fileName
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
format = try container.decodeIfPresent(String.self, forKey: .format)
title = try container.decodeIfPresent(String.self, forKey: .title)
fileName = try container.decodeIfPresent(String.self, forKey: .fileName)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if format != nil { try container.encode(format, forKey: .format) }
if title != nil { try container.encode(title, forKey: .title) }
if fileName != nil { try container.encode(fileName, forKey: .fileName) }
}
}
public class ReportDefinition : Codable
{
public var datasetCode:String
public var dimensions:[String] = []
public var measures:[ReportMeasure] = []
public var joins:[String] = []
public var filters:String
public var sorts:[ReportSort] = []
public var limit:Int
required public init(){}
}
public class ReportMeasure : Codable
{
public var fieldCode:String
public var agg:String
required public init(){}
}
public class ReportSort : Codable
{
public var fieldCode:String
public var dir:String
required public init(){}
}
Swift ReportExportRequest 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/report/export HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Format":"String","Title":"String","FileName":"String","DatasetCode":"String","Dimensions":["String"],"Measures":[{"FieldCode":"String","Agg":"String"}],"Joins":["String"],"Filters":"String","Sorts":[{"FieldCode":"String","Dir":"String"}],"Limit":0}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length (byte[])