Trendsic Platform Service

<back to all web services

ReportExportRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/report/export
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class ReportMeasure implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $FieldCode=null,
        /** @var string|null */
        public ?string $Agg=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['FieldCode'])) $this->FieldCode = $o['FieldCode'];
        if (isset($o['Agg'])) $this->Agg = $o['Agg'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->FieldCode)) $o['FieldCode'] = $this->FieldCode;
        if (isset($this->Agg)) $o['Agg'] = $this->Agg;
        return empty($o) ? new class(){} : $o;
    }
}

class ReportSort implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $FieldCode=null,
        /** @var string|null */
        public ?string $Dir=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['FieldCode'])) $this->FieldCode = $o['FieldCode'];
        if (isset($o['Dir'])) $this->Dir = $o['Dir'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->FieldCode)) $o['FieldCode'] = $this->FieldCode;
        if (isset($this->Dir)) $o['Dir'] = $this->Dir;
        return empty($o) ? new class(){} : $o;
    }
}

class ReportDefinition implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $DatasetCode=null,
        /** @var array<string>|null */
        public ?array $Dimensions=null,
        /** @var array<ReportMeasure>|null */
        public ?array $Measures=null,
        /** @var array<string>|null */
        public ?array $Joins=null,
        /** @var string|null */
        public ?string $Filters=null,
        /** @var array<ReportSort>|null */
        public ?array $Sorts=null,
        /** @var int */
        public int $Limit=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['DatasetCode'])) $this->DatasetCode = $o['DatasetCode'];
        if (isset($o['Dimensions'])) $this->Dimensions = JsonConverters::fromArray('string', $o['Dimensions']);
        if (isset($o['Measures'])) $this->Measures = JsonConverters::fromArray('ReportMeasure', $o['Measures']);
        if (isset($o['Joins'])) $this->Joins = JsonConverters::fromArray('string', $o['Joins']);
        if (isset($o['Filters'])) $this->Filters = $o['Filters'];
        if (isset($o['Sorts'])) $this->Sorts = JsonConverters::fromArray('ReportSort', $o['Sorts']);
        if (isset($o['Limit'])) $this->Limit = $o['Limit'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->DatasetCode)) $o['DatasetCode'] = $this->DatasetCode;
        if (isset($this->Dimensions)) $o['Dimensions'] = JsonConverters::toArray('string', $this->Dimensions);
        if (isset($this->Measures)) $o['Measures'] = JsonConverters::toArray('ReportMeasure', $this->Measures);
        if (isset($this->Joins)) $o['Joins'] = JsonConverters::toArray('string', $this->Joins);
        if (isset($this->Filters)) $o['Filters'] = $this->Filters;
        if (isset($this->Sorts)) $o['Sorts'] = JsonConverters::toArray('ReportSort', $this->Sorts);
        if (isset($this->Limit)) $o['Limit'] = $this->Limit;
        return empty($o) ? new class(){} : $o;
    }
}

class ReportExportRequest extends ReportDefinition implements JsonSerializable
{
    /**
     * @param string|null $DatasetCode
     * @param array<string>|null $Dimensions
     * @param array<ReportMeasure>|null $Measures
     * @param array<string>|null $Joins
     * @param string|null $Filters
     * @param array<ReportSort>|null $Sorts
     * @param int $Limit
     */
    public function __construct(
        ?string $DatasetCode=null,
        ?array $Dimensions=null,
        ?array $Measures=null,
        ?array $Joins=null,
        ?string $Filters=null,
        ?array $Sorts=null,
        int $Limit=0,
        /** @var string|null */
        public ?string $Format=null,
        /** @var string|null */
        public ?string $Title=null,
        /** @var string|null */
        public ?string $FileName=null
    ) {
        parent::__construct($DatasetCode,$Dimensions,$Measures,$Joins,$Filters,$Sorts,$Limit);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['Format'])) $this->Format = $o['Format'];
        if (isset($o['Title'])) $this->Title = $o['Title'];
        if (isset($o['FileName'])) $this->FileName = $o['FileName'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->Format)) $o['Format'] = $this->Format;
        if (isset($this->Title)) $o['Title'] = $this->Title;
        if (isset($this->FileName)) $o['FileName'] = $this->FileName;
        return empty($o) ? new class(){} : $o;
    }
}

PHP ReportExportRequest 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.

POST /v1/report/export HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ReportExportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DatasetCode>String</DatasetCode>
  <Dimensions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Dimensions>
  <Filters>String</Filters>
  <Joins xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Joins>
  <Limit>0</Limit>
  <Measures>
    <ReportMeasure>
      <Agg>String</Agg>
      <FieldCode>String</FieldCode>
    </ReportMeasure>
  </Measures>
  <Sorts>
    <ReportSort>
      <Dir>String</Dir>
      <FieldCode>String</FieldCode>
    </ReportSort>
  </Sorts>
  <FileName>String</FileName>
  <Format>String</Format>
  <Title>String</Title>
</ReportExportRequest>

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

(byte[])