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

HTTP + OTHER

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: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Dataset":{"Code":"String","Name":"String","Description":"String","Fields":[{"Code":"String","Name":"String","FieldKind":"String","DataType":"String","DefaultAggregation":"String"}],"Joins":[{"ToDatasetCode":"String","ToDatasetName":"String","Cardinality":"String","JoinType":"String"}]}}