| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/report/datasets/{DatasetCode} |
|---|
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 ReportDatasetDto
{
public virtual string Code { get; set; }
public virtual string Name { get; set; }
public virtual string Description { get; set; }
public virtual List<ReportFieldDto> Fields { get; set; } = [];
public virtual List<ReportJoinDto> Joins { get; set; } = [];
}
public partial class ReportDatasetRequest
{
public virtual string DatasetCode { get; set; }
}
public partial class ReportDatasetResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual ReportDatasetDto Dataset { get; set; }
}
public partial class ReportFieldDto
{
public virtual string Code { get; set; }
public virtual string Name { get; set; }
public virtual string FieldKind { get; set; }
public virtual string DataType { get; set; }
public virtual string DefaultAggregation { get; set; }
}
public partial class ReportJoinDto
{
public virtual string ToDatasetCode { get; set; }
public virtual string ToDatasetName { get; set; }
public virtual string Cardinality { get; set; }
public virtual string JoinType { get; set; }
}
}
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/report/datasets/{DatasetCode} 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"}},"Dataset":{"Code":"String","Name":"String","Description":"String","Fields":[{"Code":"String","Name":"String","FieldKind":"String","DataType":"String","DefaultAggregation":"String"}],"Joins":[{"ToDatasetCode":"String","ToDatasetName":"String","Cardinality":"String","JoinType":"String"}]}}