digitaluapi

GetTableRecordsRequest

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
GET, POST	/scadmeta/tables/{TablesId}/data	Gets table records

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel
Imports digitaluapi.ServiceModel.Types

Namespace Global

    Namespace digitaluapi.ServiceModel

        Public Partial Class GetTableRecordsRequest
            '''<Summary>
            '''Table id
            '''</Summary>
            <ApiMember(Description:="Table id", IsRequired:=true)>
            Public Overridable Property TablesId As Integer

            '''<Summary>
            '''Query id
            '''</Summary>
            <ApiMember(Description:="Query id")>
            Public Overridable Property QueryId As Integer?

            '''<Summary>
            '''Parameter list
            '''</Summary>
            <ApiMember(Description:="Parameter list")>
            Public Overridable Property ParameterList As Dictionary(Of String, Object)

            '''<Summary>
            '''Filter list
            '''</Summary>
            <ApiMember(Description:="Filter list")>
            Public Overridable Property FilterList As Dictionary(Of String, Object)

            Public Overridable Property Filter As List(Of Filter)
            '''<Summary>
            '''Number of items to be returned per page
            '''</Summary>
            <ApiMember(Description:="Number of items to be returned per page")>
            Public Overridable Property Paging As Paging

            '''<Summary>
            '''Drill down filter list
            '''</Summary>
            <ApiMember(Description:="Drill down filter list")>
            Public Overridable Property DrillDownFilterList As Dictionary(Of String, Object)

            '''<Summary>
            '''Global parameter list
            '''</Summary>
            <ApiMember(Description:="Global parameter list")>
            Public Overridable Property GlobalParamList As Dictionary(Of String, Object)

            '''<Summary>
            '''View id
            '''</Summary>
            <ApiMember(Description:="View id")>
            Public Overridable Property ViewId As Integer?

            '''<Summary>
            '''Whether or not to refresh the cache
            '''</Summary>
            <ApiMember(Description:="Whether or not to refresh the cache")>
            Public Overridable Property RefreshCache As Boolean
        End Class
    End Namespace

    Namespace digitaluapi.ServiceModel.Types

        Public Partial Class Filter
            Public Overridable Property Column As String
            Public Overridable Property [Operator] As String
            Public Overridable Property Value As Object
            Public Overridable Property FromVariable As String
            Public Overridable Property ToValue As Object
            Public Overridable Property ToVariable As String
        End Class

        Public Partial Class Paging
            Public Overridable Property PageNumber As Integer
            Public Overridable Property PageSize As Integer
        End Class
    End Namespace
End Namespace

VB.NET GetTableRecordsRequest DTOs

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

HTTP + 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>