Table of Contents

Search

  1. Preface
  2. Web Services
  3. SOAP Web Services
  4. WSDL Data Object
  5. Schema Object
  6. How to Create a SOAP Web Service
  7. Operation Mappings
  8. Parsing Web Service SOAP Messages
  9. Generating Web Service SOAP Messages
  10. Web Service Consumer Transformation
  11. REST Web Services
  12. How to Create a REST Web Service
  13. REST Web Service Consumer Transformation
  14. REST and SOAP Web Service Administration
  15. Datatype Compatibility

Web Services Guide

Web Services Guide

Resource Identification

Resource Identification

To identify the resource in an HTTP request, the Data Integration Service appends values in specific input ports to the base URL. You define the base URL in the HTTP connection or in the transformation properties. Use URL or argument ports to identify a particular resource.
Use URL ports when the web service identifies a resource through a unique string of characters.
For example, the HypoStores REST web service identifies parts by the part number through the following URL:
http://www.HypoStores.com/products/ProductDetails/<Part_No>
To identify a part, define the following transformation details:
  1. Set the base URL to the following URL:
    http://www.HypoStores.com/products/ProductDetails
  2. Define a URL port, and pass the part number to the transformation through the URL port.
If the mapping passes part number 500 to the URL port, the Data Integration Service uses the following URL in the request message:
http://www.HypoStores.com/products/ProductDetails/500
Use argument ports when the web service identifies the location of a resource through arguments.
For example, you want to pass a part number to the HypoStores REST web service through the "Part_No" argument.
To identify a part, define the following transformation details:
  1. Set the base URL to the following URL:
    http://www.HypoStores.com/products/ProductDetails
  2. Create an argument port with argument name "Part_No," and pass the part number to the transformation through the argument port.
If the mapping passes part number 600 to the argument port, the Data Integration Service uses the following URL in the request message:
http://www.HypoStores.com/products/ProductDetails?Part_No=600
Create multiple argument ports to define multiple arguments. The Data Integration Service separates each argument with an ampersand character (&).
For example, you want to retrieve employee details from a REST web service and pass the employee first name and last name through the "First_Name" and "Last_Name" arguments. Create argument ports with the argument names "First_Name" and "Last_Name." If the mapping passes the name "John Smith" to the transformation, the Data Integration Service uses a URL like the following in the request message:
http://www.HypoStores.com/employees/EmpDetails?First_Name=John&Last_Name=Smith
If you do not specify a URL or an argument port, the Data Integration Service uses the base URL from the transformation properties or HTTP connection to identify the resource. The base URL in the HTTP connection overrides the base URL in the transformation.