digitaluapi

<back to all web services

MetaGetTableMetaLookupById

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/scadmeta/tables/{TablesId}/meta
<?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 MetaGetTableMetaLookupResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<Object>|null */
        public ?array $Table=null,
        /** @var array<Object>|null */
        public ?array $Columns=null,
        /** @var array<Object>|null */
        public ?array $PrimaryKeys=null,
        /** @var array<Object>|null */
        public ?array $ForeignKeys=null,
        /** @var array<Object>|null */
        public ?array $LookupQueries=null,
        /** @var Object|null */
        public ?Object $Lookups=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Table'])) $this->Table = JsonConverters::fromArray('Object', $o['Table']);
        if (isset($o['Columns'])) $this->Columns = JsonConverters::fromArray('Object', $o['Columns']);
        if (isset($o['PrimaryKeys'])) $this->PrimaryKeys = JsonConverters::fromArray('Object', $o['PrimaryKeys']);
        if (isset($o['ForeignKeys'])) $this->ForeignKeys = JsonConverters::fromArray('Object', $o['ForeignKeys']);
        if (isset($o['LookupQueries'])) $this->LookupQueries = JsonConverters::fromArray('Object', $o['LookupQueries']);
        if (isset($o['Lookups'])) $this->Lookups = JsonConverters::from('Object', $o['Lookups']);
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Table)) $o['Table'] = JsonConverters::toArray('Object', $this->Table);
        if (isset($this->Columns)) $o['Columns'] = JsonConverters::toArray('Object', $this->Columns);
        if (isset($this->PrimaryKeys)) $o['PrimaryKeys'] = JsonConverters::toArray('Object', $this->PrimaryKeys);
        if (isset($this->ForeignKeys)) $o['ForeignKeys'] = JsonConverters::toArray('Object', $this->ForeignKeys);
        if (isset($this->LookupQueries)) $o['LookupQueries'] = JsonConverters::toArray('Object', $this->LookupQueries);
        if (isset($this->Lookups)) $o['Lookups'] = JsonConverters::to('Object', $this->Lookups);
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class Paging implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $PageNumber=0,
        /** @var int */
        public int $PageSize=0
    ) {
    }

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

class MetaGetTableMetaLookupById implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $TablesId=0,
        /** @var int */
        public int $DbTechnologiesId=0,
        /** @var Paging|null */
        public ?Paging $Paging=null
    ) {
    }

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

PHP MetaGetTableMetaLookupById DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /scadmeta/tables/{TablesId}/meta HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Lookups":{},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}