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 Foundation
import ServiceStack

public class GetTableRecordsRequest : Codable
{
    /**
    * Table id
    */
    // @ApiMember(Description="Table id", IsRequired=true)
    public var tablesId:Int

    /**
    * Query id
    */
    // @ApiMember(Description="Query id")
    public var queryId:Int?

    /**
    * Parameter list
    */
    // @ApiMember(Description="Parameter list")
    public var parameterList:[String:String]

    /**
    * Filter list
    */
    // @ApiMember(Description="Filter list")
    public var filterList:[String:String]

    public var filter:[Filter]
    /**
    * Number of items to be returned per page
    */
    // @ApiMember(Description="Number of items to be returned per page")
    public var paging:Paging

    /**
    * Drill down filter list
    */
    // @ApiMember(Description="Drill down filter list")
    public var drillDownFilterList:[String:String]

    /**
    * Global parameter list
    */
    // @ApiMember(Description="Global parameter list")
    public var globalParamList:[String:String]

    /**
    * View id
    */
    // @ApiMember(Description="View id")
    public var viewId:Int?

    /**
    * Whether or not to refresh the cache
    */
    // @ApiMember(Description="Whether or not to refresh the cache")
    public var refreshCache:Bool

    required public init(){}
}

public class Filter : Codable
{
    public var column:String
    public var `operator`:String
    public var value:String
    public var fromVariable:String
    public var toValue:String
    public var toVariable:String

    required public init(){}
}

public class Paging : Codable
{
    public var pageNumber:Int
    public var pageSize:Int

    required public init(){}
}


Swift GetTableRecordsRequest DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
Content-Length: length

[{}]