Table of Contents

Search

  1. Preface
  2. Introduction to REST V2 Connector
  3. REST V2 connections
  4. REST V2 operations
  5. Mappings and mapping tasks with REST V2 Connector
  6. Appendix A: Supported swagger objects

REST V2 Connector

REST V2 Connector

REST V2 Connector overview

REST V2 Connector overview

Use REST V2 Connector to interact with web service applications that support REST API. You can use REST V2 Connector in a Source transformation, Target transformation, or midstream in a Web Services transformation.
You can use REST V2 Connector midstream in a mapping to pass a single or multiple requests to a web service application and process the response data. You can also pass data obtained from multiple transformations in the mapping pipeline and process the data.
When you use REST V2 Connector midstream in a mapping, you first create a business service for the operation that you want to perform in the web service application. You then associate the business service in a Web Services transformation midstream in a mapping to read from or write data to the web service application. For example, you can use REST V2 Connector as a midstream transformation to perform PUT operation on a web service application.
You can use special characters in field names for target and midstream transformations.
You can use the following REST methods in source, target, and midstream transformation:
  • GET
  • PUT
  • POST
  • DELETE
  • OPTIONS
  • HEAD
When you can create a REST V2 connection, you can configure one of the following REST authentication types:
  • Standard
    • BASIC
    • DIGEST
    • OAuth 1.0
  • OAuth 2.0 client credentials
  • OAuth 2.0 authorization code
You can use the following media types to process data:
  • application/xml
  • application/json
  • application/x-www-form-urlencoded
  • JSON subtype. For example:
    application/
    hal+
    json
  • JSON custom type. For example:
    application/
    vnd.ds.abc.v1+
    json
  • Extended JSON mime type. For example:
    application/vnd.ds.abc.v1+json;
    version=q1
  • text/xml
If a swagger definition has multiple mime types in consumes and produces attribute values, the REST V2 Connector considers the payload to be of first mime type in the list.


Updated December 14, 2020