|
SSIS API Destination can be used to write data to popular API Data Services using predefined Connector File without learning internals of API Calls. This component also allows you to return API call response as Flat Table after you submit data.
|
Video Tutorial
Coming soon...
How to parametrize values
There are mainly three ways you can parameterize for API Destination. Check
this help page to learn more about this approach.
Method #1 - Mapping Screen (Map Upstream column to Parameter)
In previous section we saw how to Map Parameter to some upstream column to do row-by-row operation which gives you dynamic value for parameter at runtime. However there is one drawback for this approach. When you map Parameter on mapping screen (i.e. Map $$ prefixed names) it always invokes row-by-row operation regrdless Target has Bulk support or not.
Method #2 - Placeholder Engine
Method #3 - SSIS Expression
Properties
Property Name |
Description |
TableName |
Table name. This option only used when AccessMode=Table |
Parameters |
Parameters overrides for selected endpoint. Value set of these parameters overrides any default value defined in API Template |
ContinueOnUrlNotFoundError |
If this option is true then component will continue without exception on 404 error (Url not found). This allows you to consume data gracefully. |
ContineOnAnyError |
Continue when any type of exception occurs during http request |
ContineOnErrorForMessage |
Continue on error when specified substring found in response |
ContineOnErrorForStatusCode |
Continue on error when specified status code returned from web server |
ConsumeResponseOnError |
When error occurs no data is returned. Use this option to get content eventhough error occurs. When this option is checked you can't use [continue on error when specific string found in response] option |
ErrorStatusCodeToMatch |
Status code to match when error occurs and ContineOnErrorForStatusCode option is true. If Response status code matches to this code then task continues to run |
ErrorSubstringToMatch |
Error substring to match when error occurs and ContineOnErrorForMessage option is true. If Response status code matches to this code then task continues to run |
Operation |
Specifies operation for destination data load (e.g. Insert, Update, Delete etc). Default operation is Insert.
Available Options (Use numeric value listed in bracket if you have to define expression on this property (for dynamic behavior).
Option |
Description |
Insert [0] |
Insert (i.e. Create New) |
Update [1] |
Update |
Delete [2] |
Delete |
Lookup [3] |
Lookup |
Upsert [4] |
Upsert (Update or Insert) |
Select [5] |
Select |
|
OutputRaw |
Output raw data instead of parsed rows/columns in the response output for downstream. This option is ignored if EnableResponseOutput is not true. |
LoggingMode |
LoggingMode determines how much information is logged during Package Execution. Set Logging mode to Debugging for maximum log.
Available Options (Use numeric value listed in bracket if you have to define expression on this property (for dynamic behavior).
Option |
Description |
Normal [0] |
Normal |
Medium [1] |
Medium |
Detailed [2] |
Detailed |
Debugging [3] |
Debugging |
|
PrefixTimestamp |
When you enable this property it will prefix timestamp before Log messages. |
DoNotCreateOutputs |
Enable / Disable Response Output. Checking this option can remove unwanted warnings about unused Columns and many times speedup performance so if output is not needed set this option to True so its removed. |
Error Handling
- This component supports error output.
- Any bad value will cause Error or Truncation (e.g. If your sample value is 5 character long but output column length is set to 3 chars). If you have error output attached with RedirectRow option on Error, Truncation then you can capture bad rows along with exact reason of error.
- Use error handling tab to set option for error handling. By default component fails on any data error or truncation issue
Articles / Tutorials
Click here to see all articles for [SSIS API Destination] category
|
ZappySys provides high performance drag and drop connectors for API Integration. In this post you will see how to Export API Table Data to SQL Server Table using SSIS API Destination. API Destination supports SQL language to query API data. API is a powerful, open source relational database with strong reputation for reliability, feature robustness, and performance. […]
|
|
Introduction ZappySys provides high performance drag and drop connectors for API Integration. In this post you will see how to Load API Table Data to CSV File using SSIS API Destination. API Destination supports SQL language to query API data. API is a powerful, open source relational database with strong reputation for reliability, feature robustness, and performance. In […]
|
Copyrights reserved. ZappySys LLC.