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
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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ReportExportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DatasetCode>String</DatasetCode>
  <Dimensions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Dimensions>
  <Filters>String</Filters>
  <Joins xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Joins>
  <Limit>0</Limit>
  <Measures>
    <ReportMeasure>
      <Agg>String</Agg>
      <FieldCode>String</FieldCode>
    </ReportMeasure>
  </Measures>
  <Sorts>
    <ReportSort>
      <Dir>String</Dir>
      <FieldCode>String</FieldCode>
    </ReportSort>
  </Sorts>
  <FileName>String</FileName>
  <Format>String</Format>
  <Title>String</Title>
</ReportExportRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

(byte[])