REST Destination

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

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

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

Overview

The REST Destination Component is an SSIS Data Flow Component for inserting data into a REST resource.

The component dialog contains the following elements:

  • General tab - specify the destination REST resource and options.
  • Mapping tab – setup the columns to insert.
  • 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

Action

Select the destination resource action. This property has the options listed in the following table.

Action Description
Create Create new instances in the destination REST resource.
Update Update existing instances in the destination REST resource.
Delete Delete existing instances from the destination REST resource.
Upsert Update and insert records in the destination REST resource.
Resource

Select the destination REST resource.

Batch size

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

Extended Metadata

Specify additional custom metadata.

Parameters

Specify additional parameters for data insertion.

Mapping

Use the Mapping tab to map input columns to destination REST resource columns.

Input Column

Select the input columns.

Destination Column

Select the destination REST columns.

Error Output

Use the Error Output tab to select error handling options for the component.

Input or Output

View the name of the destination.

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

Description

View a description of the error.

How to modify a destination resource dynamically at runtime

The destination resource is 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 Destination].[DestinationResource]. This is the property containing the destination resource.
  • Scroll down and find the Expressions property. Set up an expression to modify the destination resource dynamically.

How to find which records contain errors

The component's Error Output is used for providing both error information and the record identifier information. Check the ErrorCode column:

ErrorCode Description
-1 Not an error record.
>0 Error record. Check the ErrorDescription column for more details.

You can set up the standard Conditional Split component to filter non-error records.