| Requires any of the roles: | Client, Admin, Partner |
| GET, POST | /scadmeta/tables/{TablesId}/data | Gets 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 .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<GetTableRecordsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
<DrillDownFilterList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
</DrillDownFilterList>
<Filter xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
<d2p1:Filter>
<d2p1:Column>String</d2p1:Column>
<d2p1:FromVariable>String</d2p1:FromVariable>
<d2p1:Operator>String</d2p1:Operator>
<d2p1:ToValue />
<d2p1:ToVariable>String</d2p1:ToVariable>
<d2p1:Value />
</d2p1:Filter>
</Filter>
<FilterList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
</FilterList>
<GlobalParamList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
</GlobalParamList>
<Paging xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
<d2p1:PageNumber>0</d2p1:PageNumber>
<d2p1:PageSize>0</d2p1:PageSize>
</Paging>
<ParameterList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
</ParameterList>
<QueryId>0</QueryId>
<RefreshCache>false</RefreshCache>
<TablesId>0</TablesId>
<ViewId>0</ViewId>
</GetTableRecordsRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ArrayOfanyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <anyType /> </ArrayOfanyType>