Trendsic Platform Service

<back to all web services

ReportDefinitionGetRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/report/definitions/{Uid}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class ReportDefinitionGetRequest
            Public Overridable Property Uid As Guid
        End Class

        Public Partial Class ReportDefinitionResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Definition As SavedReportDefinition
        End Class

        Public Partial Class SavedReportDefinition
            Public Overridable Property ReportDefinitionID As Integer
            Public Overridable Property ReportDefinitionUID As Guid
            Public Overridable Property Name As String
            Public Overridable Property Folder As String
            Public Overridable Property Kind As String
            Public Overridable Property ChartType As String
            Public Overridable Property DefinitionJson As String
            Public Overridable Property IsShared As Boolean
            Public Overridable Property IsSystem As Boolean
            Public Overridable Property OwnerUserId As String
            Public Overridable Property IsMine As Boolean
            Public Overridable Property CreatedAt As Date?
            Public Overridable Property UpdatedAt As Date?
        End Class
    End Namespace
End Namespace

VB.NET ReportDefinitionGetRequest 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/{Uid} 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
		}
	},
	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
	}
}