digitaluapi

<back to all web services

MetaGetTableMetaLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/t/{TableSchema}/{TableName}/meta
"use strict";
export class MetaGetTableMetaLookupResponse {
    /** @param {{Table?:Object[],Columns?:Object[],PrimaryKeys?:Object[],ForeignKeys?:Object[],LookupQueries?:Object[],Lookups?:Object,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Object[]} */
    Table;
    /** @type {Object[]} */
    Columns;
    /** @type {Object[]} */
    PrimaryKeys;
    /** @type {Object[]} */
    ForeignKeys;
    /** @type {Object[]} */
    LookupQueries;
    /** @type {Object} */
    Lookups;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class MetaGetTableMetaLookup {
    /** @param {{TableCatalog?:string,TableName?:string,TableSchema?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    TableCatalog;
    /** @type {string} */
    TableName;
    /** @type {string} */
    TableSchema;
}

JavaScript 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
		}
	}
}