digitaluapi

<back to all web services

GetTableRecordsRequest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET, POST/scadmeta/tables/{TablesId}/dataGets table records
GetTableRecordsRequest Parameters:
NameParameterData TypeRequiredDescription
TablesIdpathintYesTable id
QueryIdbodyint?NoQuery id
ParameterListbodyDictionary<string, Object>NoParameter list
FilterListbodyDictionary<string, Object>NoFilter list
FilterbodyList<Filter>No
PagingbodyPagingNoNumber of items to be returned per page
DrillDownFilterListbodyDictionary<string, Object>NoDrill down filter list
GlobalParamListbodyDictionary<string, Object>NoGlobal parameter list
ViewIdbodyint?NoView id
RefreshCachebodyboolNoWhether or not to refresh the cache
Filter Parameters:
NameParameterData TypeRequiredDescription
ColumnformstringNo
OperatorformstringNo
ValueformObjectNo
FromVariableformstringNo
ToValueformObjectNo
ToVariableformstringNo
Paging Parameters:
NameParameterData TypeRequiredDescription
PageNumberformintNo
PageSizeformintNo

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.

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

[
	{
		
	}
]