Endpoint Generic Read Data (XML API)
Name
read_data_xml
Description
Parameters
| Parameter | Required | Options | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Name:
Label: TableName Read data from specified module (Xml Format API) |
||||||||||||||
|
Name:
Label: Format Response format |
||||||||||||||
|
Name:
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:
Label: Search Criteria Data filter (e.g. somecolumn -eq 'somevalue' ) |
|
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
Read and write OData API data effortlessly. Query, integrate, and manage entities and feeds — almost no coding required.
OData
Generic Read Data (XML API)
| Optional Parameters | |
|---|---|
| TableName | |
API Destination
API Destination - OData
Read and write OData API data effortlessly. Query, integrate, and manage entities and feeds — almost no coding required.
OData
Generic Read Data (XML API)
| Optional Parameters | |
|---|---|
| TableName | |
ODBC application
Use these SQL queries in your ODBC application data source:
Read all records from an XML OData service table
<p>Gets all rows from a table when the service uses XML. Supply <code>TableName</code> in <code>WITH</code> to identify the entity set (e.g. <code>MyTable</code>).</p>
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
<p>Gets all rows from a table when the service uses XML. Supply <code>TableName</code> in <code>WITH</code> to identify the entity set (e.g. <code>MyTable</code>).</p>
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM read_data_xml WITH(TableName=''MyTable'')';
EXEC (@MyQuery) AT [LS_TO_ODATA_IN_GATEWAY];