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

REST Web Service Output Transformation

REST Web Service Output Transformation

The Output transformation creates the REST web service response message from groups of relational data in the operation mapping. The Developer tool creates an Output transformation when you define a REST web service.
When you create a REST web service, the Developer tool creates the Output transformation based on the resource definition that you defined. The Developer tool creates input ports for the transformation based on the response message structure. The Output transformation contains a mapping that maps input ports to nodes in the response message.
You can change the elements in the output message hierarchy by changing the schema. You can change the input ports in the transformation to correspond to the schema changes.
View the REST response message hierarchy on the Output transformation
Ports
tab. You can choose to view the transformation ports or view the a mapping between the transformation input ports and the response message hierarchy.
When you show the ports, you can manually add groups and ports or you can copy ports from other transformations into the Output transformation. You can use keyboard shortcuts or you can use the copy and the paste buttons in the Developer tool.
When you show the output mapping, you can define input groups, define input ports, and map input ports to response message elements. The left side of the tab is the
Ports
area and the right side of the tab is the
Output
area. The
Output
area shows the response message hierarchy. Define input groups and ports in the
Ports
area. When you map the input ports from the
Ports
area to nodes in the
Output
area, the input port location appears in the
Location
column in the
Output
area.
When you show the output mapping, you can choose to view the lines that connect the input ports to the nodes in the operation input.
The following image shows a simple output mapping in an Output transformation:
The Output transformation Ports tab shows an output mapping where customer fields are mapped from the Ports area to the nodes in the Output area.
In the previous image, the transformation receives one group of ports for a customer. It returns single-occurring elements.
The Developer tool maps input ports to nodes in the first level of the operation output when you choose to map the first level of the hierarchy. The
Map First Level Hierarchy
option is enabled by default. The Developer tool also creates the input ports that it requires to map the data. If the first level of the hierarchy contains a multi-occurring parent node with one or more multi-occurring child nodes, the Developer tool does not create the ports or map the first level of the hierarchy.