Trendsic Platform Service

<back to all web services

ReportDefinitionListRequest

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

public class ReportDefinitionListRequest : Codable
{
    required public init(){}
}

public class ReportDefinitionListResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var definitions:[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 ReportDefinitionListRequest DTOs

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

HTTP + JSV

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

GET /v1/report/definitions HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Definitions: 
	[
		{
			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-01,
			UpdatedAt: 0001-01-01
		}
	]
}