digitaluapi

MetaGetTableMetaLookup

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
GET	/t/{TableSchema}/{TableName}/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 MetaGetTableMetaLookup implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $TableCatalog=null,
        /** @var string|null */
        public ?string $TableName=null,
        /** @var string|null */
        public ?string $TableSchema=null
    ) {
    }

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

PHP MetaGetTableMetaLookup DTOs

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

HTTP + JSV

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

GET /t/{TableSchema}/{TableName}/meta HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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