Trendsic Platform Service

ReportExportRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
POST,OPTIONS	/v1/report/export

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportMeasure:
    field_code: Optional[str] = None
    agg: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportSort:
    field_code: Optional[str] = None
    dir: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportDefinition:
    dataset_code: Optional[str] = None
    dimensions: List[str] = field(default_factory=list)
    measures: List[ReportMeasure] = field(default_factory=list)
    joins: List[str] = field(default_factory=list)
    filters: Optional[str] = None
    sorts: List[ReportSort] = field(default_factory=list)
    limit: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportExportRequest(ReportDefinition):
    format: Optional[str] = None
    title: Optional[str] = None
    file_name: Optional[str] = None

Python 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[])