Trendsic Platform Service

ReportRunRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
POST,OPTIONS	/v1/report/run

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class ReportColumnMeta
    {
        public virtual string Code { get; set; }
        public virtual string Name { get; set; }
        public virtual string DataType { get; set; }
        public virtual string FieldKind { get; set; }
        public virtual string Agg { get; set; }
    }

    public partial class ReportDefinition
    {
        public virtual string DatasetCode { get; set; }
        public virtual List<string> Dimensions { get; set; } = [];
        public virtual List<ReportMeasure> Measures { get; set; } = [];
        public virtual List<string> Joins { get; set; } = [];
        public virtual string Filters { get; set; }
        public virtual List<ReportSort> Sorts { get; set; } = [];
        public virtual int Limit { get; set; }
    }

    public partial class ReportMeasure
    {
        public virtual string FieldCode { get; set; }
        public virtual string Agg { get; set; }
    }

    public partial class ReportRunRequest
        : ReportDefinition
    {
    }

    public partial class ReportRunResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual ReportRunResult Result { get; set; }
    }

    public partial class ReportRunResult
    {
        public virtual List<ReportColumnMeta> Columns { get; set; } = [];
        public virtual List<Dictionary<String,Object>> Rows { get; set; } = [];
        public virtual int RowCount { get; set; }
        public virtual bool Truncated { get; set; }
        public virtual List<string> Notes { get; set; } = [];
    }

    public partial class ReportSort
    {
        public virtual string FieldCode { get; set; }
        public virtual string Dir { get; set; }
    }

}

C# ReportRunRequest DTOs

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

HTTP + OTHER

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

POST /v1/report/run HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"DatasetCode":"String","Dimensions":["String"],"Measures":[{"FieldCode":"String","Agg":"String"}],"Joins":["String"],"Filters":"String","Sorts":[{"FieldCode":"String","Dir":"String"}],"Limit":0}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Result":{"Columns":[{"Code":"String","Name":"String","DataType":"String","FieldKind":"String","Agg":"String"}],"Rows":[{"String":{}}],"RowCount":0,"Truncated":false,"Notes":["String"]}}