| Requires any of the roles: | Client, Admin, Partner |
| GET, POST | /scadmeta/tables/{TablesId}/data | Gets table records |
|---|
"use strict";
export class Filter {
/** @param {{Column?:string,Operator?:string,Value?:Object,FromVariable?:string,ToValue?:Object,ToVariable?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Column;
/** @type {string} */
Operator;
/** @type {Object} */
Value;
/** @type {string} */
FromVariable;
/** @type {Object} */
ToValue;
/** @type {string} */
ToVariable;
}
export class Paging {
/** @param {{PageNumber?:number,PageSize?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
PageNumber;
/** @type {number} */
PageSize;
}
export class GetTableRecordsRequest {
/** @param {{TablesId?:number,QueryId?:number,ParameterList?:{ [index:string]: Object; },FilterList?:{ [index:string]: Object; },Filter?:Filter[],Paging?:Paging,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 {?number}
* @description Query id */
QueryId;
/**
* @type {{ [index:string]: Object; }}
* @description Parameter list */
ParameterList;
/**
* @type {{ [index:string]: Object; }}
* @description Filter list */
FilterList;
/** @type {Filter[]} */
Filter;
/**
* @type {Paging}
* @description Number of items to be returned per page */
Paging;
/**
* @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 GetTableRecordsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /scadmeta/tables/{TablesId}/data HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
TablesId: 0,
QueryId: 0,
ParameterList:
{
String: {}
},
FilterList:
{
String: {}
},
Filter:
[
{
Column: String,
Operator: String,
Value: {},
FromVariable: String,
ToValue: {},
ToVariable: String
}
],
Paging:
{
PageNumber: 0,
PageSize: 0
},
DrillDownFilterList:
{
String: {}
},
GlobalParamList:
{
String: {}
},
ViewId: 0,
RefreshCache: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
[
{
}
]