Trendsic Platform Service

<back to all web services

ReportDefinitionUpdateRequest

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

public class ReportDefinitionUpdateRequest : Codable
{
    public var uid: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

    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 ReportDefinitionUpdateRequest 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.

PUT /v1/report/definitions/{Uid} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Uid: 00000000000000000000000000000000,
	Name: String,
	Folder: String,
	Kind: String,
	ChartType: String,
	DefinitionJson: String,
	IsShared: False
}
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
		}
	},
	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-01,
		UpdatedAt: 0001-01-01
	}
}