Trendsic Platform Service

<back to all web services

ReportDefinitionGetRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/report/definitions/{Uid}
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 SavedReportDefinition() = 
        member val ReportDefinitionID:Int32 = new Int32() with get,set
        member val ReportDefinitionUID:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Folder:String = null with get,set
        member val Kind:String = null with get,set
        member val ChartType:String = null with get,set
        member val DefinitionJson:String = null with get,set
        member val IsShared:Boolean = new Boolean() with get,set
        member val IsSystem:Boolean = new Boolean() with get,set
        member val OwnerUserId:String = null with get,set
        member val IsMine:Boolean = new Boolean() with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type ReportDefinitionResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Definition:SavedReportDefinition = null with get,set

    [<AllowNullLiteral>]
    type ReportDefinitionGetRequest() = 
        member val Uid:Guid = new Guid() with get,set

F# ReportDefinitionGetRequest 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/definitions/{Uid} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReportDefinitionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Definition>
    <ChartType>String</ChartType>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <DefinitionJson>String</DefinitionJson>
    <Folder>String</Folder>
    <IsMine>false</IsMine>
    <IsShared>false</IsShared>
    <IsSystem>false</IsSystem>
    <Kind>String</Kind>
    <Name>String</Name>
    <OwnerUserId>String</OwnerUserId>
    <ReportDefinitionID>0</ReportDefinitionID>
    <ReportDefinitionUID>00000000-0000-0000-0000-000000000000</ReportDefinitionUID>
    <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
  </Definition>
  <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>
</ReportDefinitionResponse>