Support for Standard and Historical Datasets

 

REST API calls can be used to return standard datasets and historical datasets.  

The following is an example standard dataset API call that returns data from the Northwind Orders table where the ShipCountry is "Germany":

 

https://hostname/fwxapi/odata/v1/ODataDataset?pointName=db:Northwind.Orders&$filter=(ShipCountry eq 'Germany')&$count=true&$top=3&$format=application/json;odata.metadata=none

 

The following is an example historical dataset API call for the Signals > SineFast point.

 

https://hostname/fwxapi/odata/v1/ODataHistory?pointName=hh:\Configuration\Signals:SineFast&StartDate=2020-07-21T11:25:00-0400&EndDate=2020-07-21T11:27:00-0400&$count=true&$filter=(statusCode eq 0)&$top=8

 

API calls can only return one "page" of data at a time, up to 100 records per page. (This limit is configurable as MaxItemCount in the IcoOData.json file, located in the ICONICS\GENESIS64\WebSites\IcoWebAPIService\ folder.) If more than 100 records are available, the call returns a continuation token (X-ICO-CONTINUATION header). The next API call can use this continuation token to request the next 100 items. This can be repeated until the call returns no continuation token.

 

See Also:

Web API

Configuring ICONICS Web API Service

REST API Reference