Trendsic Platform Service

<back to all web services

ReportManagerObjectFieldsRequest

The following routes are available for this service:
GET,OPTIONS/v1/ReportManager/api/Objects/{Table}/fields
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


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportManagerRequest(Generic[T], IReturn[List[T]]):
    @staticmethod
    def response_type(): return List[T]


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportManagerObjectData:
    id: Optional[str] = None
    name: Optional[str] = None
    filter: bool = False
    edit: bool = False
    type_name: Optional[str] = None
    ref: Optional[str] = None
    is_key: bool = False
    is_label: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportManagerObjectRef:
    id: int = 0
    target: Optional[str] = None
    source: Optional[str] = None
    name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportManagerObject(IReportManagerDocument):
    id: Optional[str] = None
    name: Optional[str] = None
    fields: List[ReportManagerObjectData] = field(default_factory=list)
    references: List[ReportManagerObjectRef] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportManagerObjectFieldsRequest(ReportManagerRequest[ReportManagerObject]):
    table: Optional[str] = None

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

GET /v1/ReportManager/api/Objects/{Table}/fields HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		id: String,
		name: String,
		data: 
		[
			{
				id: String,
				name: String,
				filter: False,
				edit: False,
				type: String,
				ref: String,
				key: False,
				show: False
			}
		],
		refs: 
		[
			{
				id: 0,
				target: String,
				source: String,
				name: String
			}
		]
	}
]