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

public class dtos
{

    public static class GetTableRecordsRequest
    {
        /**
        * Table id
        */
        @ApiMember(Description="Table id", IsRequired=true)
        public Integer TablesId = null;

        /**
        * Query id
        */
        @ApiMember(Description="Query id")
        public Integer QueryId = null;

        /**
        * Parameter list
        */
        @ApiMember(Description="Parameter list")
        public HashMap<String,Object> ParameterList = null;

        /**
        * Filter list
        */
        @ApiMember(Description="Filter list")
        public HashMap<String,Object> FilterList = null;

        public ArrayList<Filter> Filter = null;
        /**
        * Number of items to be returned per page
        */
        @ApiMember(Description="Number of items to be returned per page")
        public Paging Paging = null;

        /**
        * Drill down filter list
        */
        @ApiMember(Description="Drill down filter list")
        public HashMap<String,Object> DrillDownFilterList = null;

        /**
        * Global parameter list
        */
        @ApiMember(Description="Global parameter list")
        public HashMap<String,Object> GlobalParamList = null;

        /**
        * View id
        */
        @ApiMember(Description="View id")
        public Integer ViewId = null;

        /**
        * Whether or not to refresh the cache
        */
        @ApiMember(Description="Whether or not to refresh the cache")
        public Boolean RefreshCache = null;
        
        public Integer getTablesId() { return TablesId; }
        public GetTableRecordsRequest setTablesId(Integer value) { this.TablesId = value; return this; }
        public Integer getQueryId() { return QueryId; }
        public GetTableRecordsRequest setQueryId(Integer value) { this.QueryId = value; return this; }
        public HashMap<String,Object> getParameterList() { return ParameterList; }
        public GetTableRecordsRequest setParameterList(HashMap<String,Object> value) { this.ParameterList = value; return this; }
        public HashMap<String,Object> getFilterList() { return FilterList; }
        public GetTableRecordsRequest setFilterList(HashMap<String,Object> value) { this.FilterList = value; return this; }
        public ArrayList<Filter> getFilter() { return Filter; }
        public GetTableRecordsRequest setFilter(ArrayList<Filter> value) { this.Filter = value; return this; }
        public Paging getPaging() { return Paging; }
        public GetTableRecordsRequest setPaging(Paging value) { this.Paging = value; return this; }
        public HashMap<String,Object> getDrillDownFilterList() { return DrillDownFilterList; }
        public GetTableRecordsRequest setDrillDownFilterList(HashMap<String,Object> value) { this.DrillDownFilterList = value; return this; }
        public HashMap<String,Object> getGlobalParamList() { return GlobalParamList; }
        public GetTableRecordsRequest setGlobalParamList(HashMap<String,Object> value) { this.GlobalParamList = value; return this; }
        public Integer getViewId() { return ViewId; }
        public GetTableRecordsRequest setViewId(Integer value) { this.ViewId = value; return this; }
        public Boolean isRefreshCache() { return RefreshCache; }
        public GetTableRecordsRequest setRefreshCache(Boolean value) { this.RefreshCache = value; return this; }
    }

    public static class Filter
    {
        public String Column = null;
        public String Operator = null;
        public Object Value = null;
        public String FromVariable = null;
        public Object ToValue = null;
        public String ToVariable = null;
        
        public String getColumn() { return Column; }
        public Filter setColumn(String value) { this.Column = value; return this; }
        public String getOperator() { return Operator; }
        public Filter setOperator(String value) { this.Operator = value; return this; }
        public Object getValue() { return Value; }
        public Filter setValue(Object value) { this.Value = value; return this; }
        public String getFromVariable() { return FromVariable; }
        public Filter setFromVariable(String value) { this.FromVariable = value; return this; }
        public Object getToValue() { return ToValue; }
        public Filter setToValue(Object value) { this.ToValue = value; return this; }
        public String getToVariable() { return ToVariable; }
        public Filter setToVariable(String value) { this.ToVariable = value; return this; }
    }

    public static class Paging
    {
        public Integer PageNumber = null;
        public Integer PageSize = null;
        
        public Integer getPageNumber() { return PageNumber; }
        public Paging setPageNumber(Integer value) { this.PageNumber = value; return this; }
        public Integer getPageSize() { return PageSize; }
        public Paging setPageSize(Integer value) { this.PageSize = value; return this; }
    }

}

Java GetTableRecordsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
Content-Length: length

[{}]