| Requires any of the roles: | Client, Admin, Partner |
| GET, POST | /scadmeta/tables/{TablesId}/data | Gets table records |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Filter:
column: Optional[str] = None
operator: Optional[str] = None
value: Optional[Object] = None
from_variable: Optional[str] = None
to_value: Optional[Object] = None
to_variable: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Paging:
page_number: int = 0
page_size: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetTableRecordsRequest:
# @ApiMember(Description="Table id", IsRequired=true)
tables_id: int = 0
"""
Table id
"""
# @ApiMember(Description="Query id")
query_id: Optional[int] = None
"""
Query id
"""
# @ApiMember(Description="Parameter list")
parameter_list: Optional[Dict[str, Object]] = None
"""
Parameter list
"""
# @ApiMember(Description="Filter list")
filter_list: Optional[Dict[str, Object]] = None
"""
Filter list
"""
filter: Optional[List[Filter]] = None
# @ApiMember(Description="Number of items to be returned per page")
paging: Optional[Paging] = None
"""
Number of items to be returned per page
"""
# @ApiMember(Description="Drill down filter list")
drill_down_filter_list: Optional[Dict[str, Object]] = None
"""
Drill down filter list
"""
# @ApiMember(Description="Global parameter list")
global_param_list: Optional[Dict[str, Object]] = None
"""
Global parameter list
"""
# @ApiMember(Description="View id")
view_id: Optional[int] = None
"""
View id
"""
# @ApiMember(Description="Whether or not to refresh the cache")
refresh_cache: bool = False
"""
Whether or not to refresh the cache
"""
Python 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>