Trendsic Platform Service

<back to all web services

ReportManagerDataRequest

The following routes are available for this service:
GET,POST,OPTIONS/v1/ReportManager/api/Objects/{Table}/data
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 JToken(IJsonLineInfo):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JValue(JToken):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSqlResult:
    sql: Optional[str] = None
    values: Optional[Dict[str, JValue]] = None
    error: Optional[str] = None
    has_error: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportManagerDataJoin:
    source: Optional[str] = None
    target: Optional[str] = None
    source_field: Optional[str] = None
    target_field: Optional[str] = None
    id: Optional[str] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportManagerDataBucketOption:
    id: Optional[str] = None
    values: List[Object] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportManagerDataBucket:
    bucket_column: Optional[str] = None
    options: List[ReportManagerDataBucketOption] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportManagerDataRequest:
    table: Optional[str] = None
    table_key: Optional[str] = None
    query: Optional[str] = None
    query_cast: Optional[GetSqlResult] = None
    columns: List[str] = field(default_factory=list)
    joins: Optional[str] = None
    joins_cast: List[ReportManagerDataJoin] = field(default_factory=list)
    limit: Optional[str] = None
    sort: Optional[str] = None
    sort_cast: List[ReportManagerDataSort] = field(default_factory=list)
    group: List[str] = field(default_factory=list)
    buckets: Optional[str] = None
    buckets_cast: List[ReportManagerDataBucket] = field(default_factory=list)

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

POST /v1/ReportManager/api/Objects/{Table}/data HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{Unable to show example output for type 'ReportManagerDataRequest' using the custom 'other' filter}One or more errors occurred.
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

[{"String":{}}]