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
namespace digitaluapi.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Filter() = 
        member val Column:String = null with get,set
        member val Operator:String = null with get,set
        member val Value:Object = null with get,set
        member val FromVariable:String = null with get,set
        member val ToValue:Object = null with get,set
        member val ToVariable:String = null with get,set

    [<AllowNullLiteral>]
    type Paging() = 
        member val PageNumber:Int32 = new Int32() with get,set
        member val PageSize:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type GetTableRecordsRequest() = 
        ///<summary>
        ///Table id
        ///</summary>
        [<ApiMember(Description="Table id", IsRequired=true)>]
        member val TablesId:Int32 = new Int32() with get,set

        ///<summary>
        ///Query id
        ///</summary>
        [<ApiMember(Description="Query id")>]
        member val QueryId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Parameter list
        ///</summary>
        [<ApiMember(Description="Parameter list")>]
        member val ParameterList:Dictionary<String, Object> = null with get,set

        ///<summary>
        ///Filter list
        ///</summary>
        [<ApiMember(Description="Filter list")>]
        member val FilterList:Dictionary<String, Object> = null with get,set

        member val Filter:ResizeArray<Filter> = null with get,set
        ///<summary>
        ///Number of items to be returned per page
        ///</summary>
        [<ApiMember(Description="Number of items to be returned per page")>]
        member val Paging:Paging = null with get,set

        ///<summary>
        ///Drill down filter list
        ///</summary>
        [<ApiMember(Description="Drill down filter list")>]
        member val DrillDownFilterList:Dictionary<String, Object> = null with get,set

        ///<summary>
        ///Global parameter list
        ///</summary>
        [<ApiMember(Description="Global parameter list")>]
        member val GlobalParamList:Dictionary<String, Object> = null with get,set

        ///<summary>
        ///View id
        ///</summary>
        [<ApiMember(Description="View id")>]
        member val ViewId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Whether or not to refresh the cache
        ///</summary>
        [<ApiMember(Description="Whether or not to refresh the cache")>]
        member val RefreshCache:Boolean = new Boolean() with get,set

F# 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>