Use custom queries for Generic REST API
- Last UpdatedFeb 09, 2024
- 2 minute read
An Azure function is used to flatten the data from Generic Rest API data source for data transformation in BI Gateway. The following custom queries are available for use in the Custom Query expression editor.
The custom query expression supports the following parameters.
|
Parameter Name |
Parameter Choice |
Example (using common Insight REST API queries) |
Description |
|---|---|---|---|
|
QueryName |
Required |
WeatherTags |
BI Gateway data source query name You can define the QueryName as per your requirements. |
|
Method |
Required |
Get |
Method used to perform action on the http request. Generic REST API data adapter currently supports only the Get method. |
|
ItemPath |
Required |
For example, if the generic Rest API URL is https://online.wonderware.com/ apis/Historian/v2/Tags, then the ItemPath is apis/Historian/v2/Tags. |
The ItemPath is added to the base URL. The combination of base URL and Item Path represent the REST API end point. |
|
QueryParameter |
Optional |
"$filter=startswith(FQN, 'Weather.Los Angeles ')" |
A defined set of parameters attached to the end of a URL. To add multiple parameters, add an ‘&’ between each parameter. Note: QueryParameter may be optional for some endpoints. In such cases, the URL may only have the base URL and the ItemPath. |
|
NextPage |
If the REST API has pagination, specify this parameter. |
JSON Output with Pagination to be specified |
Used to apply pagination if the data retrieved spans more than 1 page. |
The following are the sample query expressions which support Generic REST API.
Note: The value @odata.nextLink used for the NextPage parameter is applicable only for Insight APIs which support pagination.
The value CIMv3 for the APIType parameter is applicable only for Insight CIM API.
The value ADH for the APIType parameter is applicable only for Insight ADH API.