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

Advanced source properties

Advanced source properties

In a mapping, you can configure a source to represent a web service application source. For the REST source connections used in a mapping, you can configure advanced properties in the
Source
tab in the Mapping Designer.
The following table describes the advanced properties that you can configure in a source:
Property
Description
Paging Type
Specify one of the following values:
Page
. Enables paging support for REST V2 Connector and considers the values of Page Parameter, Start Page, End Page, and End of Response Expression properties.
None
. Ignores the values of Page Parameter, Start Page, End Page, and End of Response Expression properties.
Page Parameter
The name of the parameter that you want to use for the paging operation. You can use a query parameter or a path parameter.
The parameter must be of the integer type and from the request message.
Start Page
The page number that indicates the first page in the range, on which you want to perform the paging operation.
End Page
The page number that indicates the last page in the range, on which you want to perform the paging operation. The default is 10000.
Paging stops when the End Page is reached or the End of Response Expression is met.
Page Increment Factor
An integer to increment the Page Parameter. Page Increment Factor must be same as the number of records being fetched per request.
If the Page Increment Parameter option is not same as the number of records being fetched per request, you might have missing or duplicate records between two calls.
End of Response Expression
Specify an expression or a string to control paging. You can observe one of the following behaviors:
  • If you specify a string or an expression, the paging stops when the value matches with the page response. It does not parse the page that has matching end of response.
  • If you do not specify a string or an expression, the paging stops on reaching a page that has an empty or a Null response. If an empty or a Null response is never reached, the paging stops at the default end page.
  • If you specify both, End Page and End of Response Expression, the paging stops on whichever condition is met first.
  • If you do not specify End Page and End of Response Expression, the paging stops on reaching an empty or a Null response. If an empty or a Null response is never reached, the paging stops at the default end page.
Override URL
Overrides the URL specified in the swagger specification. The override URL cannot have query parameters. When a path parameter is included in the Override URL, enclose the path parameter with curly brackets {}. For example:
URL specified in the swagger specification:
http://invr28pers102:13080/sample/day/20170505?a:b
If you define 20170505 as a path variable with the path variable name as
path1
, the Override URL will be as follows:
http://invr28pers102:13080/sample/day/
{
path1
}
Tracing Level
Amount of detail that appears in the log for the source.
Use the following tracing levels:
  • Terse
  • Normal
  • Verbose Initialization
  • Verbose
Default is normal.
Cache Size for Web Service Response (KB)
Memory available for the web service response. If the web service response contains many rows or columns, you might want to increase the cache size. Default is 1024 KB.

Sample End of Response Expression

Use End of Response Expression for paging. The following snippet shows a sample response for a page :
{
"code": "SUCCESS",
"validationResult": [],
"systemErrors": [],
"patientResponseData": [],
"count": 0,
"message": "Unable to retrieve the implant details"
}
For End of Response Expression, you can use the string, Unable to retrieve the implant details. If you want to match multiple conditions in the response page, you can use the following expression:
(.*)"patientResponseData": [](.*)Unable to retrieve the implant details
The above expression ensures that the paging will stop when both "patientResponseData": [] and Unable to retrieve the implant details are matched in the page response.


Updated December 14, 2020