Trendsic Platform Service

<back to all web services

ReportDatasetsRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/report/datasets
import 'package:servicestack/servicestack.dart';

class ReportFieldDto implements IConvertible
{
    String? Code;
    String? Name;
    String? FieldKind;
    String? DataType;
    String? DefaultAggregation;

    ReportFieldDto({this.Code,this.Name,this.FieldKind,this.DataType,this.DefaultAggregation});
    ReportFieldDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Code = json['Code'];
        Name = json['Name'];
        FieldKind = json['FieldKind'];
        DataType = json['DataType'];
        DefaultAggregation = json['DefaultAggregation'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Code': Code,
        'Name': Name,
        'FieldKind': FieldKind,
        'DataType': DataType,
        'DefaultAggregation': DefaultAggregation
    };

    getTypeName() => "ReportFieldDto";
    TypeContext? context = _ctx;
}

class ReportJoinDto implements IConvertible
{
    String? ToDatasetCode;
    String? ToDatasetName;
    String? Cardinality;
    String? JoinType;

    ReportJoinDto({this.ToDatasetCode,this.ToDatasetName,this.Cardinality,this.JoinType});
    ReportJoinDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ToDatasetCode = json['ToDatasetCode'];
        ToDatasetName = json['ToDatasetName'];
        Cardinality = json['Cardinality'];
        JoinType = json['JoinType'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ToDatasetCode': ToDatasetCode,
        'ToDatasetName': ToDatasetName,
        'Cardinality': Cardinality,
        'JoinType': JoinType
    };

    getTypeName() => "ReportJoinDto";
    TypeContext? context = _ctx;
}

class ReportDatasetDto implements IConvertible
{
    String? Code;
    String? Name;
    String? Description;
    List<ReportFieldDto>? Fields = [];
    List<ReportJoinDto>? Joins = [];

    ReportDatasetDto({this.Code,this.Name,this.Description,this.Fields,this.Joins});
    ReportDatasetDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Code = json['Code'];
        Name = json['Name'];
        Description = json['Description'];
        Fields = JsonConverters.fromJson(json['Fields'],'List<ReportFieldDto>',context!);
        Joins = JsonConverters.fromJson(json['Joins'],'List<ReportJoinDto>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Code': Code,
        'Name': Name,
        'Description': Description,
        'Fields': JsonConverters.toJson(Fields,'List<ReportFieldDto>',context!),
        'Joins': JsonConverters.toJson(Joins,'List<ReportJoinDto>',context!)
    };

    getTypeName() => "ReportDatasetDto";
    TypeContext? context = _ctx;
}

class ReportDatasetsResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<ReportDatasetDto>? Datasets = [];

    ReportDatasetsResponse({this.ResponseStatus,this.Datasets});
    ReportDatasetsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        Datasets = JsonConverters.fromJson(json['Datasets'],'List<ReportDatasetDto>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'Datasets': JsonConverters.toJson(Datasets,'List<ReportDatasetDto>',context!)
    };

    getTypeName() => "ReportDatasetsResponse";
    TypeContext? context = _ctx;
}

class ReportDatasetsRequest implements IConvertible
{
    ReportDatasetsRequest();
    ReportDatasetsRequest.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "ReportDatasetsRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'ReportFieldDto': TypeInfo(TypeOf.Class, create:() => ReportFieldDto()),
    'ReportJoinDto': TypeInfo(TypeOf.Class, create:() => ReportJoinDto()),
    'ReportDatasetDto': TypeInfo(TypeOf.Class, create:() => ReportDatasetDto()),
    'List<ReportFieldDto>': TypeInfo(TypeOf.Class, create:() => <ReportFieldDto>[]),
    'List<ReportJoinDto>': TypeInfo(TypeOf.Class, create:() => <ReportJoinDto>[]),
    'ReportDatasetsResponse': TypeInfo(TypeOf.Class, create:() => ReportDatasetsResponse()),
    'List<ReportDatasetDto>': TypeInfo(TypeOf.Class, create:() => <ReportDatasetDto>[]),
    'ReportDatasetsRequest': TypeInfo(TypeOf.Class, create:() => ReportDatasetsRequest()),
});

Dart ReportDatasetsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/report/datasets HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReportDatasetsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Datasets>
    <ReportDatasetDto>
      <Code>String</Code>
      <Description>String</Description>
      <Fields>
        <ReportFieldDto>
          <Code>String</Code>
          <DataType>String</DataType>
          <DefaultAggregation>String</DefaultAggregation>
          <FieldKind>String</FieldKind>
          <Name>String</Name>
        </ReportFieldDto>
      </Fields>
      <Joins>
        <ReportJoinDto>
          <Cardinality>String</Cardinality>
          <JoinType>String</JoinType>
          <ToDatasetCode>String</ToDatasetCode>
          <ToDatasetName>String</ToDatasetName>
        </ReportJoinDto>
      </Joins>
      <Name>String</Name>
    </ReportDatasetDto>
  </Datasets>
  <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>
</ReportDatasetsResponse>