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
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class GetTableRecordsRequest
{
    /**
    * Table id
    */
    @ApiMember(Description="Table id", IsRequired=true)
    open var TablesId:Int? = null

    /**
    * Query id
    */
    @ApiMember(Description="Query id")
    open var QueryId:Int? = null

    /**
    * Parameter list
    */
    @ApiMember(Description="Parameter list")
    open var ParameterList:HashMap<String,Object>? = null

    /**
    * Filter list
    */
    @ApiMember(Description="Filter list")
    open var FilterList:HashMap<String,Object>? = null

    open var Filter:ArrayList<Filter>? = null
    /**
    * Number of items to be returned per page
    */
    @ApiMember(Description="Number of items to be returned per page")
    open var Paging:Paging? = null

    /**
    * Drill down filter list
    */
    @ApiMember(Description="Drill down filter list")
    open var DrillDownFilterList:HashMap<String,Object>? = null

    /**
    * Global parameter list
    */
    @ApiMember(Description="Global parameter list")
    open var GlobalParamList:HashMap<String,Object>? = null

    /**
    * View id
    */
    @ApiMember(Description="View id")
    open var ViewId:Int? = null

    /**
    * Whether or not to refresh the cache
    */
    @ApiMember(Description="Whether or not to refresh the cache")
    open var RefreshCache:Boolean? = null
}

open class Filter
{
    open var Column:String? = null
    open var Operator:String? = null
    open var Value:Object? = null
    open var FromVariable:String? = null
    open var ToValue:Object? = null
    open var ToVariable:String? = null
}

open class Paging
{
    open var PageNumber:Int? = null
    open var PageSize:Int? = null
}

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

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

[
	{
		
	}
]