EndPoint Generic Read Data (XML API)
Parameters
| Parameter | Label | Required | Options | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| TableName | TableName | NO | Read data from specified module (Xml Format API) | |||||||||||||
| Format | Format | NO | Response format | |||||||||||||
| PageSize | PageSize (Keep blank for default) | NO | Number which indicates max rows per response. Keep it blank to use API default vlaue. Read your API documentation to findout default value. | |||||||||||||
| SearchCriteria | Search Criteria | NO |
|
Data filter (e.g. somecolumn -eq 'somevalue' ) [API reference] |
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Raw | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Input Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Raw | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
SSIS
Use OData Connector in API Source component to read data or in API Destination component to read/write data:
Generic Read Data (XML API) using API Source
OData
Generic Read Data (XML API)
Generic Read Data (XML API) using API Destination
OData
Generic Read Data (XML API)
ODBC application
Use these SQL queries in your ODBC application data source:
Read all records from an XML OData Service Table
SELECT * FROM read_data_xml WITH(TableName='MyTable')SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
Read all records from an XML OData Service Table
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM read_data_xml WITH(TableName=''MyTable'')';
EXEC (@MyQuery) AT [LINKED_SERVER_TO_ODATA_IN_DATA_GATEWAY];