| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/report/definitions/{Uid} |
|---|
import 'package:servicestack/servicestack.dart';
class SavedReportDefinition implements IConvertible
{
int? ReportDefinitionID;
String? ReportDefinitionUID;
String? Name;
String? Folder;
String? Kind;
String? ChartType;
String? DefinitionJson;
bool? IsShared;
bool? IsSystem;
String? OwnerUserId;
bool? IsMine;
DateTime? CreatedAt;
DateTime? UpdatedAt;
SavedReportDefinition({this.ReportDefinitionID,this.ReportDefinitionUID,this.Name,this.Folder,this.Kind,this.ChartType,this.DefinitionJson,this.IsShared,this.IsSystem,this.OwnerUserId,this.IsMine,this.CreatedAt,this.UpdatedAt});
SavedReportDefinition.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ReportDefinitionID = json['ReportDefinitionID'];
ReportDefinitionUID = json['ReportDefinitionUID'];
Name = json['Name'];
Folder = json['Folder'];
Kind = json['Kind'];
ChartType = json['ChartType'];
DefinitionJson = json['DefinitionJson'];
IsShared = json['IsShared'];
IsSystem = json['IsSystem'];
OwnerUserId = json['OwnerUserId'];
IsMine = json['IsMine'];
CreatedAt = JsonConverters.fromJson(json['CreatedAt'],'DateTime',context!);
UpdatedAt = JsonConverters.fromJson(json['UpdatedAt'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => {
'ReportDefinitionID': ReportDefinitionID,
'ReportDefinitionUID': ReportDefinitionUID,
'Name': Name,
'Folder': Folder,
'Kind': Kind,
'ChartType': ChartType,
'DefinitionJson': DefinitionJson,
'IsShared': IsShared,
'IsSystem': IsSystem,
'OwnerUserId': OwnerUserId,
'IsMine': IsMine,
'CreatedAt': JsonConverters.toJson(CreatedAt,'DateTime',context!),
'UpdatedAt': JsonConverters.toJson(UpdatedAt,'DateTime',context!)
};
getTypeName() => "SavedReportDefinition";
TypeContext? context = _ctx;
}
class ReportDefinitionResponse implements IConvertible
{
ResponseStatus? ResponseStatus;
SavedReportDefinition? Definition;
ReportDefinitionResponse({this.ResponseStatus,this.Definition});
ReportDefinitionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
Definition = JsonConverters.fromJson(json['Definition'],'SavedReportDefinition',context!);
return this;
}
Map<String, dynamic> toJson() => {
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
'Definition': JsonConverters.toJson(Definition,'SavedReportDefinition',context!)
};
getTypeName() => "ReportDefinitionResponse";
TypeContext? context = _ctx;
}
class ReportDefinitionGetRequest implements IConvertible
{
String? Uid;
ReportDefinitionGetRequest({this.Uid});
ReportDefinitionGetRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Uid = json['Uid'];
return this;
}
Map<String, dynamic> toJson() => {
'Uid': Uid
};
getTypeName() => "ReportDefinitionGetRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
'SavedReportDefinition': TypeInfo(TypeOf.Class, create:() => SavedReportDefinition()),
'ReportDefinitionResponse': TypeInfo(TypeOf.Class, create:() => ReportDefinitionResponse()),
'ReportDefinitionGetRequest': TypeInfo(TypeOf.Class, create:() => ReportDefinitionGetRequest()),
});
Dart ReportDefinitionGetRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/report/definitions/{Uid} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ReportDefinitionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Definition>
<ChartType>String</ChartType>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<DefinitionJson>String</DefinitionJson>
<Folder>String</Folder>
<IsMine>false</IsMine>
<IsShared>false</IsShared>
<IsSystem>false</IsSystem>
<Kind>String</Kind>
<Name>String</Name>
<OwnerUserId>String</OwnerUserId>
<ReportDefinitionID>0</ReportDefinitionID>
<ReportDefinitionUID>00000000-0000-0000-0000-000000000000</ReportDefinitionUID>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
</Definition>
<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>
</ReportDefinitionResponse>