xAPPnow LOW CODE PLATFORM - User Manual 

Still no account yet?
×

Service Model  - REST API Connector Configuration

 
 
This topic describes the Configuration of a REST API Connector, which is available in a Sub TAB of the Implementation TAB.
 
The following properties are available for those element:
 
  • Method: the HTTP Method the REST API Connector should execute
  • Use Proxy: Enables the use of the User Portal as proxy in a client service model
  • Timeout: the timeout in milliseconds for the REST call
  • Retry Number: the number of retried calls
  • Retry Delay: the delay in milliseconds between two retried calls
  • Connection Object: the authentication for the REST endpoint containing the url of the service
  • Error Object:  the object where the error is saved in case an error is thrown
  • Connection Domain: the attribute containing the domain name where the external system is created. This is an optional field and by default the external system should be created on current domain
  • Use Soap: enables the use of soap requests
 
The REST API Connector provides the integration of external application services through a REST endpoint.
 
The REST API Connector must have a Service Integration submodel assigned. After the submodel is assigned to the REST API connector the Method combobox provides all methods defined in the corresponding Service Integration model. Each method requires a method specific data mapping, which has to be configured in the Mapping TAB.
 
 
 
Service Model - REST API Connector Configuration
 
 
1

Select method

1. Select method
Select a method of the REST API connector. This list of methods is displayed according to the methods defined in the Service Integration Model selected as submodel of the current REST API Connector.
2

Enter timeout

2. Enter timeout
Enter a timeout [msec] for the connection.
3

Enter retry
number

3. Enter retry number
Enter a number of retries for the connection.
4

Enter retry
delay

4. Enter retry delay
Enter a retry delay [msec] for the connection.
5

Set Connection

5. Set Connection
Map an connection object to set the basic authentication.
It contains user and password for access the service and the url of the service. The connection parameter must be mapped from the Definition Object subtab.
6

Get Error BO

6. Get Error BO
Map an error object to get the error code and details.
Similar to all other connectors the REST API Connector has a Fatal flow in case an error happens. In this field the error object can be mapped. This object must be defined first in a Definition Object Model and then on Business Object Model.
7

Connection Domain

7. Connection Domain
<TODO>: Insert description text here...
8

Select Use Soap

8. Select Use Soap
<TODO>: Insert description text here...