REST Source

SQL Server 2005, 2008, 2008R2, 2012, 2014, 2016

SQL Server 2005, 2008, 2008R2, 2012, 2014, 2016

All Downloads ----- Join VIP ----- Questions?

Overview

The REST Source Component is an SSIS Data Flow Component for consuming data from REST services.

The component dialog contains the following elements:

  • General tab - specify the source REST resource.
  • Columns tab - select the columns to load.
  • Error Output tab - specify error handling options.


Setup

Use the parameters below to set up the component.

General

Connection

Select the COZYROC REST connection manager.

Related Topics: REST Connection Manager

Resource

Select a REST resource as the source.

Batch size

Specify the number of rows to be retrieved as a batch. Default is 200.

Extended Metadata

Specify additional custom metadata.

Parameters

Specify one or more filters for the data retrieval. A grid with filters help is displayed under the filter's entry grid.

Columns

Use the Columns tab to specify which columns are to be processed from the source REST resource and to specify new names for the columns being processed, if desired.

Available External Columns

This table lists the columns, by name, that are available to be processed from the source REST resource. If there are columns that you do not want to process, uncheck them from the list.

External Column

Shows the columns that will be processed from the source REST resource based on the columns selected in the Available External Columns list.

Output Column

This shows the column name that will be used during processing. The name of any column may be changed by typing over the text in this list. Each name must be unique.

Error Output

Use the Error Output page to select error handling options for the columns.

Input or Output

View the name of the data source.

Column

View the selected source column.

Error

Specify what should happen when an error occurs: ignore the failure, redirect the row, or fail the component.

Related Topics: Handling Errors in Data

Truncation

Specify what should happen when a truncation occurs: ignore the failure, redirect the row, or fail the component.

Description

View a description of the error.

How to modify the source dynamically at runtime

The source resource and filters are available in the data flow properties list. Follow these steps to set up an expression:

  • Right-click on the data flow canvas and select the Properties menu.
  • Scroll down and find the property named like [REST Source].[Resource]. This is the property containing the resource.
  • Scroll down and find the property named like [REST Source].[ResourceParameter]. This is the property containing the resource parameters. The property is a string combination with format [name]=[value]. Each value is separated with a newline (\n).
  • Scroll down and find the Expressions property. Set up an expression to modify the resource or parameters dynamically.