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


export class Filter
{
    public Column: string;
    public Operator: string;
    public Value: Object;
    public FromVariable: string;
    public ToValue: Object;
    public ToVariable: string;

    public constructor(init?: Partial<Filter>) { (Object as any).assign(this, init); }
}

export class Paging
{
    public PageNumber: number;
    public PageSize: number;

    public constructor(init?: Partial<Paging>) { (Object as any).assign(this, init); }
}

export class GetTableRecordsRequest
{
    /** @description Table id */
    // @ApiMember(Description="Table id", IsRequired=true)
    public TablesId: number;

    /** @description Query id */
    // @ApiMember(Description="Query id")
    public QueryId?: number;

    /** @description Parameter list */
    // @ApiMember(Description="Parameter list")
    public ParameterList: { [index:string]: Object; };

    /** @description Filter list */
    // @ApiMember(Description="Filter list")
    public FilterList: { [index:string]: Object; };

    public Filter: Filter[];
    /** @description Number of items to be returned per page */
    // @ApiMember(Description="Number of items to be returned per page")
    public Paging: Paging;

    /** @description Drill down filter list */
    // @ApiMember(Description="Drill down filter list")
    public DrillDownFilterList: { [index:string]: Object; };

    /** @description Global parameter list */
    // @ApiMember(Description="Global parameter list")
    public GlobalParamList: { [index:string]: Object; };

    /** @description View id */
    // @ApiMember(Description="View id")
    public ViewId?: number;

    /** @description Whether or not to refresh the cache */
    // @ApiMember(Description="Whether or not to refresh the cache")
    public RefreshCache: boolean;

    public constructor(init?: Partial<GetTableRecordsRequest>) { (Object as any).assign(this, init); }
}

TypeScript GetTableRecordsRequest DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
Content-Length: length

[{}]