Trendsic Platform Service

<back to all web services

ReportDefinitionListRequest

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

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 ReportDefinitionListResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<SavedReportDefinition>? Definitions = [];

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

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

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

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

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

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'SavedReportDefinition': TypeInfo(TypeOf.Class, create:() => SavedReportDefinition()),
    'ReportDefinitionListResponse': TypeInfo(TypeOf.Class, create:() => ReportDefinitionListResponse()),
    'List<SavedReportDefinition>': TypeInfo(TypeOf.Class, create:() => <SavedReportDefinition>[]),
    'ReportDefinitionListRequest': TypeInfo(TypeOf.Class, create:() => ReportDefinitionListRequest()),
});

Dart ReportDefinitionListRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}]}