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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ReportFieldDto() = 
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val FieldKind:String = null with get,set
        member val DataType:String = null with get,set
        member val DefaultAggregation:String = null with get,set

    [<AllowNullLiteral>]
    type ReportJoinDto() = 
        member val ToDatasetCode:String = null with get,set
        member val ToDatasetName:String = null with get,set
        member val Cardinality:String = null with get,set
        member val JoinType:String = null with get,set

    [<AllowNullLiteral>]
    type ReportDatasetDto() = 
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val Fields:ResizeArray<ReportFieldDto> = new ResizeArray<ReportFieldDto>() with get,set
        member val Joins:ResizeArray<ReportJoinDto> = new ResizeArray<ReportJoinDto>() with get,set

    [<AllowNullLiteral>]
    type ReportDatasetsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Datasets:ResizeArray<ReportDatasetDto> = new ResizeArray<ReportDatasetDto>() with get,set

    [<AllowNullLiteral>]
    type ReportDatasetsRequest() = 
        class end

F# 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>