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

"use strict";
export class Filter {
    /** @param {{Column?:string,Operator?:string,Value?:Object,FromVariable?:string,ToValue?:Object,ToVariable?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Column;
    /** @type {string} */
    Operator;
    /** @type {Object} */
    Value;
    /** @type {string} */
    FromVariable;
    /** @type {Object} */
    ToValue;
    /** @type {string} */
    ToVariable;
}
export class Paging {
    /** @param {{PageNumber?:number,PageSize?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    PageNumber;
    /** @type {number} */
    PageSize;
}
export class GetTableRecordsRequest {
    /** @param {{TablesId?:number,QueryId?:number,ParameterList?:{ [index:string]: Object; },FilterList?:{ [index:string]: Object; },Filter?:Filter[],Paging?:Paging,DrillDownFilterList?:{ [index:string]: Object; },GlobalParamList?:{ [index:string]: Object; },ViewId?:number,RefreshCache?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Table id */
    TablesId;
    /**
     * @type {?number}
     * @description Query id */
    QueryId;
    /**
     * @type {{ [index:string]: Object; }}
     * @description Parameter list */
    ParameterList;
    /**
     * @type {{ [index:string]: Object; }}
     * @description Filter list */
    FilterList;
    /** @type {Filter[]} */
    Filter;
    /**
     * @type {Paging}
     * @description Number of items to be returned per page */
    Paging;
    /**
     * @type {{ [index:string]: Object; }}
     * @description Drill down filter list */
    DrillDownFilterList;
    /**
     * @type {{ [index:string]: Object; }}
     * @description Global parameter list */
    GlobalParamList;
    /**
     * @type {?number}
     * @description View id */
    ViewId;
    /**
     * @type {boolean}
     * @description Whether or not to refresh the cache */
    RefreshCache;
}

JavaScript 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>