Trendsic Platform Service

ReportDatasetRequest

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

The following routes are available for this service:
GET,OPTIONS	/v1/report/datasets/{DatasetCode}

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 ReportFieldDto:
    code: Optional[str] = None
    name: Optional[str] = None
    field_kind: Optional[str] = None
    data_type: Optional[str] = None
    default_aggregation: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportJoinDto:
    to_dataset_code: Optional[str] = None
    to_dataset_name: Optional[str] = None
    cardinality: Optional[str] = None
    join_type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportDatasetDto:
    code: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None
    fields: List[ReportFieldDto] = field(default_factory=list)
    joins: List[ReportJoinDto] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportDatasetResponse:
    response_status: Optional[ResponseStatus] = None
    dataset: Optional[ReportDatasetDto] = None


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

Python ReportDatasetRequest 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.

GET /v1/report/datasets/{DatasetCode} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReportDatasetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Dataset>
    <Code>String</Code>
    <Description>String</Description>
    <Fields>
      <ReportFieldDto>
        <Code>String</Code>
        <DataType>String</DataType>
        <DefaultAggregation>String</DefaultAggregation>
        <FieldKind>String</FieldKind>
        <Name>String</Name>
      </ReportFieldDto>
    </Fields>
    <Joins>
      <ReportJoinDto>
        <Cardinality>String</Cardinality>
        <JoinType>String</JoinType>
        <ToDatasetCode>String</ToDatasetCode>
        <ToDatasetName>String</ToDatasetName>
      </ReportJoinDto>
    </Joins>
    <Name>String</Name>
  </Dataset>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</ReportDatasetResponse>