Reference

Endpoint Generic Read Data (XML API)

Name

read_data_xml

Description

No description available

Parameters

Parameter Required Options
Name: TableName

Label: TableName

Read data from specified module (Xml Format API)
Name: Format

Label: Format

Response format
Name: PageSize

Label: PageSize (Keep blank for default)

Number which indicates max rows per response. Keep it blank to use API default vlaue. Read your API documentation to findout default value.
Name: SearchCriteria

Label: Search Criteria

Data filter (e.g. somecolumn -eq 'somevalue' )
Option Value
None
Equal Serach SomeColumn eq 'SomeValue'
Sub String Serach substringof(SomeField,'abc')
Starts With startswith(SomeField, 'abc')
Value Greater Than filter=mynumericfield gt 1234

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.
If the column you are looking for is missing, consider customizing OData Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length 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 or in API Destination SSIS Data Flow components to read or write data.

API Source

API Source - OData
OData Connector can be used to integrated any REST API which supports OData Standard. You can view tables, read data from tables using this connector. It also comes with some example OData Services to get started.
OData
Generic Read Data (XML API)
Optional Parameters
TableName
SSIS API Source - Read from table or endpoint

API Destination

API Destination - OData
OData Connector can be used to integrated any REST API which supports OData Standard. You can view tables, read data from tables using this connector. It also comes with some example OData Services to get started.
OData
Generic Read Data (XML API)
Optional Parameters
TableName
SSIS API Destination - Access table or endpoint

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 [LS_TO_ODATA_IN_GATEWAY];