Trendsic Platform Service

<back to all web services

ReportDefinitionCreateRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/report/definitions
import Foundation
import ServiceStack

public class ReportDefinitionCreateRequest : Codable
{
    public var name:String
    public var folder:String
    public var kind:String
    public var chartType:String
    public var definitionJson:String
    public var isShared:Bool

    required public init(){}
}

public class ReportDefinitionResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var definition:SavedReportDefinition

    required public init(){}
}

public class SavedReportDefinition : Codable
{
    public var reportDefinitionID:Int
    public var reportDefinitionUID:String
    public var name:String
    public var folder:String
    public var kind:String
    public var chartType:String
    public var definitionJson:String
    public var isShared:Bool
    public var isSystem:Bool
    public var ownerUserId:String
    public var isMine:Bool
    public var createdAt:Date?
    public var updatedAt:Date?

    required public init(){}
}


Swift ReportDefinitionCreateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/report/definitions HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Name":"String","Folder":"String","Kind":"String","ChartType":"String","DefinitionJson":"String","IsShared":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Definition":{"ReportDefinitionID":0,"ReportDefinitionUID":"00000000000000000000000000000000","Name":"String","Folder":"String","Kind":"String","ChartType":"String","DefinitionJson":"String","IsShared":false,"IsSystem":false,"OwnerUserId":"String","IsMine":false,"CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}}