| 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 .jsv suffix or ?format=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
[
{
}
]