| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/report/definitions |
|---|
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 SavedReportDefinition:
report_definition_i_d: int = 0
report_definition_u_i_d: Optional[str] = None
name: Optional[str] = None
folder: Optional[str] = None
kind: Optional[str] = None
chart_type: Optional[str] = None
definition_json: Optional[str] = None
is_shared: bool = False
is_system: bool = False
owner_user_id: Optional[str] = None
is_mine: bool = False
created_at: Optional[datetime.datetime] = None
updated_at: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportDefinitionListResponse:
response_status: Optional[ResponseStatus] = None
definitions: List[SavedReportDefinition] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportDefinitionListRequest:
pass
Python ReportDefinitionListRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/report/definitions HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Definitions:
[
{
ReportDefinitionID: 0,
ReportDefinitionUID: 00000000000000000000000000000000,
Name: String,
Folder: String,
Kind: String,
ChartType: String,
DefinitionJson: String,
IsShared: False,
IsSystem: False,
OwnerUserId: String,
IsMine: False,
CreatedAt: 0001-01-01,
UpdatedAt: 0001-01-01
}
]
}