Trendsic Platform Service

ReportDatasetRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/report/datasets/{DatasetCode}

<?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 ReportFieldDto implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Code=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $FieldKind=null,
        /** @var string|null */
        public ?string $DataType=null,
        /** @var string|null */
        public ?string $DefaultAggregation=null
    ) {
    }

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

class ReportJoinDto implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ToDatasetCode=null,
        /** @var string|null */
        public ?string $ToDatasetName=null,
        /** @var string|null */
        public ?string $Cardinality=null,
        /** @var string|null */
        public ?string $JoinType=null
    ) {
    }

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

class ReportDatasetDto implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Code=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Description=null,
        /** @var array<ReportFieldDto>|null */
        public ?array $Fields=null,
        /** @var array<ReportJoinDto>|null */
        public ?array $Joins=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Code'])) $this->Code = $o['Code'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['Fields'])) $this->Fields = JsonConverters::fromArray('ReportFieldDto', $o['Fields']);
        if (isset($o['Joins'])) $this->Joins = JsonConverters::fromArray('ReportJoinDto', $o['Joins']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Code)) $o['Code'] = $this->Code;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->Fields)) $o['Fields'] = JsonConverters::toArray('ReportFieldDto', $this->Fields);
        if (isset($this->Joins)) $o['Joins'] = JsonConverters::toArray('ReportJoinDto', $this->Joins);
        return empty($o) ? new class(){} : $o;
    }
}

class ReportDatasetResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var ReportDatasetDto|null */
        public ?ReportDatasetDto $Dataset=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['Dataset'])) $this->Dataset = JsonConverters::from('ReportDatasetDto', $o['Dataset']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->Dataset)) $o['Dataset'] = JsonConverters::to('ReportDatasetDto', $this->Dataset);
        return empty($o) ? new class(){} : $o;
    }
}

class ReportDatasetRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $DatasetCode=null
    ) {
    }

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

PHP ReportDatasetRequest DTOs

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

HTTP + JSON

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"}]}}