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

GET /t/{TableSchema}/{TableName}/meta HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MetaGetTableMetaLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Columns xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <ForeignKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <LookupQueries xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <Lookups />
  <PrimaryKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Table xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
</MetaGetTableMetaLookupResponse>