Trendsic Platform Service

<back to all web services

ReportExportRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/report/export
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class ReportDefinition
    {
        public virtual string DatasetCode { get; set; }
        public virtual List<string> Dimensions { get; set; } = [];
        public virtual List<ReportMeasure> Measures { get; set; } = [];
        public virtual List<string> Joins { get; set; } = [];
        public virtual string Filters { get; set; }
        public virtual List<ReportSort> Sorts { get; set; } = [];
        public virtual int Limit { get; set; }
    }

    public partial class ReportExportRequest
        : ReportDefinition
    {
        public virtual string Format { get; set; }
        public virtual string Title { get; set; }
        public virtual string FileName { get; set; }
    }

    public partial class ReportMeasure
    {
        public virtual string FieldCode { get; set; }
        public virtual string Agg { get; set; }
    }

    public partial class ReportSort
    {
        public virtual string FieldCode { get; set; }
        public virtual string Dir { get; set; }
    }

}

C# ReportExportRequest 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.

POST /v1/report/export HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length

(byte[])