Rest Destination

Parent Previous Next


Rest Destination


The "REST Destination" enables users to connect to a web service that utilizes a REST API and send data to it. See the Rest Source Connection Manager, Rest Source OAuth Connection Manager, and Rest Source OAuth2 Connection Manager for more information about configuring the component's connection manager.


Important Note

Rest Destination is available for SQL versions 2012 and higher.


API Endpoint


  Endpoint URL - Users set the URL of the web service and choose the method making the call:

o  Post - (Default) Request that the destination URI perform and action with the provided data.

o  Get - Retrieves data from the destination

o  Put - Stores data at a URI and can be used to create a new entity or update an existing one.

o  Delete - Requests that data be removed

o  Patch - Requests an update to the specified fields of an entity at a URI.

  Post Data - The user defined data used in the post request

  Timeout - Sets the number of seconds the component should fail if there is no response from the web service.

  Number of Retries - Indicates the number of times to retry connecting to the API before the component fails.

  Cookie Container - Used to identify the variable that stores a returned cookie response. The variable must be of object datatype.


Important Notes

The Endpoint URL and Post Data uses auto-complete for source columns and variables. Source columns are surrounded in curly braces {{ColumnName}}. Variables use the following format: <@User::MyVariable>.


Headers



Headers are information about the type of data returned.

Users can add and remove headers by clicking the corresponding buttons. Click the header's Name and Variable Name fields to configure them after they are added. (Source columns and variables can be used as header values. Columns are surrounded in curly braces {{ColumnName}}. Variables use the following format: <@User::MyVariable>.)


Valid Status Codes





 Valid Status Codes - Users can add the code to report when a valid request is made. When several status codes are used, they should be separated with the | ("pipe") character. (In most cases, 200 is the only valid status code.)

 Error Handling:

o  Not Used - Error handling will not be used and no error constraint will be available.

o  Ignore Failure - All errors will be ignored and the package will continue to execute.

o  Redirect Row - All errors will be directed to an error output.

o  Fail Component - (Default) On error, the component will fail execution and stop the package.



Test Endpoint



The Test Endpoint button produces a sample output based on the user's configuration.  Values can be substituted by entering them in the table above the Test Endpoint button.  (Input Column Names cannot be changed.) The Results tab displays the data returned in the request. The Request tab displays the actual request made to the endpoint.


Endpoints





 Choose Configuration - This view displays the configuration name and endpoint value. This is generated from the configuration file chosen in an OAuth2 connection manager. Parameters are configured by selecting the endpoint and clicking the Choose Configuration button. (This will open a parameter window.)  


Rest Destination Response Output


The Rest Destination uses the "successful" output to capture responses from the service.



Output responses are output as NTEXT datatypes. To view the response in a data viewer, users will need to use SSIS's native Data Conversion component.