Using the HTTP Requester Task
The HTTP Requester Task is an SSIS control flow task component that can be used to send an HTTP request and receive a response. A common use case for this component is to download a file.
The component includes the following two pages to configure how the request should be sent and how to process the response:
- Error Handling
The General page of the HTTP Requester Task allows you to specify the general settings of the component.
The HTTP Requester Task requires a connection in order to connect to the web service. The Connection Manager drop-down will show a list of all connection managers that are available to your current SSIS package.
Note that the Connection Managers offered within this toolkit are the following:
- HTTP Connection Manager
- Relative Path
The Relative Path field allows you to specify a string containing the relative location of the URL the request will be sent to. The base URL comes from the connection manager. For example if you want to download a file called "file1.txt" from http://www.example.com/ you would create a connection manager with the base URL http://www.example.com/ and in the HTTP Requester Task set the Relative Path to "file1.txt".
The Body field allow you to enter the body of your request. The body editor provides three formatting options: PlainText, JSON, XML. If the connection manager is using the GET method, such as when downloading files, the body would typically be left empty.
- Query String Parameters
The Query String Parameters grid allows you to add query string parameters and values that will be appended to the URL of the request.
- Response Body Output
The Response Body Output radio buttons determines what will happen with the response body. The following options are available:
- None - The response body not used for anything.
- Output To Variable - The response body is output to a variable. Selecting this option will enable a drop down field that allows a variable to be chosen.
- Output To File - The response body is saved to a file. Selecting this option will enable a text field where the file name can be entered.
- File Path
The File Path field allows you to set an input column that will determine the path of the file where the request response body will be saved. This field will only enabled if the the response body output field is set to Output To File.
Error Handling page
The Error Handling page allows you to specify how errors should be handled when they happen.
There is one option available.
- Continue on Error
Checking or unchecking this option will determine if the task should continue or fail when an error occurs.