General page of the REST step in (DataStage)
On the General page of the REST step, you can set up a connection to the REST web service. You can also create a reusable connection that can be used to set up the connections for multiple REST steps.
You must specify values for the following
fields to configure connection settings for the REST web service.
- HTTP method
- Select the HTTP methods to use to connect to the REST web service.
- GET
- Retrieves the information in the form of an entity that is identified by the request Uniform Resource Identifier (URI) of the request body.
- POST
- Requests that the origin server accept the data that is enclosed in the body of the request message. This method is often used to upload resource data.
- PUT
- Requests that the enclosed entity is to be stored under the request URI that is specified.
- DELETE
- Requests that the origin server delete the resource that is identified by the request URI.
- OPTIONS
- Displays a list of HTTP methods that are supported by the server for the specified URI.
- HEAD
- Retrieves only the header information in the response. This method is often used to verify that hypertext links are valid and identify whether the links changed.
- PATCH
- Changes existing resources. You can use the PATCH method to update a single field of the resource.
- Reusable connection
- You can reuse a connection object that was created in another REST step in the same assembly. Reusable connections are available only in the assembly where you created them. While the job is running, the connection is shared to start multiple REST services created by the multiple steps that use the same reusable connection. The reusable connection is also designed to pass the session cookies among various requests without any user configuration. Reusable connection saves the time of creating a connection with the server where the REST service is deployed. When the Reusable connection option is selected, the URL suffix field is shown on the General page in which you specify a part of the URL of the REST service.
- URL
- Specify a URL string for the REST web service. You can include a local parameter in the URL by
specifying the <localparam> tag. You must map the local parameters to input
data items or fixed values on the Mappings page. To specify a DataStage® job parameter in the URL at run time,
click the Insert parameter icon (
{#}), and then select the name of a job parameter.
- HTTP version
- Select the HTTP version on which you want to run the REST web service. The OPTIONS method is not available for HTTP Version 1.0 because the OPTIONS method was introduced in HTTP Version 1.1.
- Timeout duration
- Specify the number of milliseconds to wait before the request times out. The default value is 5000 milliseconds, and the maximum value is 1800000 milliseconds.
- Proxy configuration
- Select this option to choose a proxy server as an intermediate gateway for accessing REST
resources. Click Configure to specify the connection details, such as name,
port, realm, domain, username, and password to use to connect to the proxy server.
If this option is selected, the client uses an HTTP proxy server to connect to the destination. The proxy server then connects on behalf of the client. When the connection is established, the proxy server maintains the TCP stream to and from the client.
- Abort job on error
- Select this option to stop the job when the REST call fails.