Trendsic Platform Service

<back to all web services

ReportDatasetRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/report/datasets/{DatasetCode}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class ReportDatasetDto
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property Fields As List(Of ReportFieldDto) = New List(Of ReportFieldDto)
            Public Overridable Property Joins As List(Of ReportJoinDto) = New List(Of ReportJoinDto)
        End Class

        Public Partial Class ReportDatasetRequest
            Public Overridable Property DatasetCode As String
        End Class

        Public Partial Class ReportDatasetResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Dataset As ReportDatasetDto
        End Class

        Public Partial Class ReportFieldDto
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property FieldKind As String
            Public Overridable Property DataType As String
            Public Overridable Property DefaultAggregation As String
        End Class

        Public Partial Class ReportJoinDto
            Public Overridable Property ToDatasetCode As String
            Public Overridable Property ToDatasetName As String
            Public Overridable Property Cardinality As String
            Public Overridable Property JoinType As String
        End Class
    End Namespace
End Namespace

VB.NET ReportDatasetRequest 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/{DatasetCode} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReportDatasetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Dataset>
    <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>
  </Dataset>
  <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>
</ReportDatasetResponse>