digitaluapi

GetTableForeignKeysRequest

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

The following routes are available for this service:
GET	/scadmeta/tables/{TablesId}/fkeys	Gets table primary keys id

"use strict";
export class Paging {
    /** @param {{PageNumber?:number,PageSize?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    PageNumber;
    /** @type {number} */
    PageSize;
}
export class GetTableForeignKeysRequest {
    /** @param {{TablesId?:number,ParameterList?:{ [index:string]: Object; },FilterList?:{ [index:string]: Object; },Paging?:Paging,FromId?:number,DrillDownFilterList?:{ [index:string]: Object; },GlobalParamList?:{ [index:string]: Object; },ViewId?:number,RefreshCache?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Table id */
    TablesId;
    /**
     * @type {{ [index:string]: Object; }}
     * @description Parameter list */
    ParameterList;
    /**
     * @type {{ [index:string]: Object; }}
     * @description Filter list */
    FilterList;
    /**
     * @type {Paging}
     * @description Number of items to be returned per page */
    Paging;
    /** @type {number} */
    FromId;
    /**
     * @type {{ [index:string]: Object; }}
     * @description Drill down filter list */
    DrillDownFilterList;
    /**
     * @type {{ [index:string]: Object; }}
     * @description Global parameter list */
    GlobalParamList;
    /**
     * @type {?number}
     * @description View id */
    ViewId;
    /**
     * @type {boolean}
     * @description Whether or not to refresh the cache */
    RefreshCache;
}

JavaScript GetTableForeignKeysRequest 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 /scadmeta/tables/{TablesId}/fkeys HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfanyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <anyType />
</ArrayOfanyType>