Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The following parameters can be set for the service from Encore:

NameDescriptionTypeRequiredDirectionSelect module
restServiceThe name of the REST service along with the module where it is defined.Module ElementYesInputYes
operationThe name of the operation of the REST service that needs to be called.StringYesInputNo
urlThe URL of the REST webservice.String ExpressionNoInputNo
connectionOverride

The name to use when overriding connection in the Runtime configuration files (more about this in the following section).

Not that if the expression returns the value unknown ( ? ) as result, an error is thrown. In this scenario no fallback is used.

String ExpressionNoInputNo
mappingThe name of the data mapping to use along with the module where it can be found.Data mappingNoBiDirectionalNo
usernameThe username to use in the service calling.StringNoInputNo
passwordThe password to use in the service calling.StringNoInputNo

Overriding parameters

The parameters url, username and password can be overridden in the Runtime's configuration files.

...

  • The exception exit can be used to handle exceptions such as a failing data mapping, or a response body that doesn't match the domain schema.
  • Use the exit events to handle timeouts, client errors (http status code 4xx), and server errors (http status code 5xx).
    • If there is a need to distinguish on a more specific http status code than the aforemantioned ranges, you can use the header in the REST service to map the status code with the name "Status" to the profile.

Exit events

NameDescriptionType
TimeoutWhen the REST request returns a timeout exception.

Continue

ClientError (since 16.7)When the REST request returns a 4xx exception.

Continue

ServerError (since 16.7)When the REST request returns a 5xx exception.

Continue

default exit event

All unmapped events will be redirected to the default exit node of the service call, even errors. Therefore it is recommended to always map all possible expected exit events.

Continue

Authentication options

There are several authentication options, which are configurable per connection with properties:

...