Rest adaptor

Rest adaptor DEFAULT

Configuring the REST AdapterLocate this document in the navigation structure

Configuring the Java REST Adapter

The Representational State Transfer (REST) adapter enables you to exchange messages between remote clients or web service servers and the Integration Server.

It supports dynamic URLs, REST API polling, multiple operations per channel as well as XML and JSON data formats.

NoteFor FAQs about REST adapter, see SAP Note 2032345 Information published on SAP site.
  1. Create a communication channel in the Integration Directory
  2. Choose Adapter Type
    • Name: REST
    • Namespace:
    • Software component version: SAP BASIS 7.31
  3. Specify the Direction (Sender or Receiver)
The adapter-specific parameters that you have to provide depend on whether it is a sender or receiver channel.

For the OE Mobile applications we have designed a REST Adapter which works within TomCat (or another JSE but TomCat is the preferred, supported, shipped JSE). 

Representational State Transfer (REST) is an architecture for distributed applications that was developed along with the HTTP protocol. REST is an approach where addressable resources represent identifiable entities in an application. Each resource is addressed using URIs (or URLs) using the stand

and HTTP verbs: POST, GET, PUT, and DELETE, roughly corresponding to Create, Read, Update, Delete in the database CRUD model. 

REST offers a simpler alternative to the more complex and restrictive SOAP-based web services model. Similar to SOAP, RESTful web services enable communication between heterogeneous systems using standard protocols and message formats.
The standard protocol used is HTTP.
The standard data formats used are typically XML or JSON.

RESTful Web Services are self-contained applications that can be published and invoked from anywhere on the internet and consequently are popular for implementing applications in the Cloud. 

The advantage of RESTful systems is that they are highly scalable and highly flexible. Because the resources are accessed and manipulated using the four HTTP verbs, the resources are exposed using a URI, and the resources are represented using standard grammars, clients are not as affected by changes to the servers. Also, REST style systems can take full advantage of the scalability features of HTTP such as caching and proxies. 

This new adapter provides feature for the AppServer that facilitates building applications using the REST paradigm. 

  1. 1982 les paul
  2. Irish sterling silver earrings
  3. Hydroponic plant basket

The Representational State Transfer (REST) adapter enables you to exchange messages between remote clients or web service servers and the Integration Server. It supports dynamic URLs, REST API polling, multiple operations per channel as well as XML and JSON data formats.

Rest adapter is used for data processing of both direction. I,e Inbound and outbound.

REST request-> Outbound interface

Rest response-> Inbound interface

What is REST request?

REST requires that a client make a request to the server in order to retrieve or modify data on the server. A request generally consists of: an HTTP verb, which defines what kind of operation to perform. a header, which allows the client to pass along information about the request.

Request Structure:

What is Rest response?

When an JSON String is sent to a REST service, you must set Content-Type HTTP header to be “application/JSON”. The REST service converts the XML input data to the JSON format that is accepted by REST services.

Response Structure:

Resource Methods:
Other important thing associated with REST is resource methods to be used to perform the desired transition. A large number of people wrongly relate resource methods to HTTP GET/PUT/POST/DELETE methods.

Authentication Section:
Here we make authentication three-way like
1) Basic Authentication
2) Certificate Authentication
3) OAuth2.0 Authentication

1) If the authentication type is Basic then the following properties required.
Authentication Type: Basic,
API Service Endpoint URL,
Request Format,
Response Format,
REST URL Path Parameter(optional)

2)If the authentication type is Certificate then the following properties required.
Authentication Type: Certificate,
API Service Endpoint URL,
Request Format,
Response Format,
REST URL Path Parameter(optional)

3)If the authentication type is Oauth2.0 then the following properties required.
Authentication Type: Oauth2.0,
API Service Endpoint URL,
Token Endpoint URL,
Request Format,
Response Format,
REST URL Path Parameter(optional)

OAuth 20 Flow: Username-Password Credential
//Below properties required for access service
OAuth 20 client-id
OAuth 20 client-secret
OAuth 20 access-token

OAuth 20 Flow: Client Credential
//Below properties required for access service
OAuth 20 client-id
OAuth 20 client-secret
OAuth 20 access-token
OAuth 20 refresh-token

OAuth 20 Flow: OAuth 20 refresh-token
//Below properties required for access service
OAuth 20 client-id
OAuth 20 client-secret
OAuth 20 access-token
OAuth 20 refresh-token

Message Type Template:

Rest Adapter Template



Step1: Create Adapter

  • First Insert Adapter Record By giving prefer Name and select Type = REST
  • Now Insert Properties If Need Authorization.
  • REST API Service Endpoint URL : “” , Insert Endpoint URL where Request will direct
  • Username : “”, Your Endservice UserName
  • Password : “”, Your Endservice Password
  • Authentication : “BASIC”
  • REST Operation : “POST”

Step2: Create message type for REST template

Manual  create message type for REST template (google drive api)Manual  create message type for REST template (google drive api)

Step 3: Create interface request(outbound) and interface response (inbound) , link interface inbound to outbound :Configuration on Interface using for google 

How to Link response Interface:

Scroll the page to the Inbound/Outbound set up section. And select the response interface.

Link rest Adapter to Request interface


skyvvasolutions.CallOutControl c = new skyvvasolutions.CallOutControl();




String[] ids= new String[]{‘0011X00000TdIAXQA3′,’0011X00000TdIAYQA3′,’0011X00000TdIAZQA3’};


Fandest du diesen Artikel hilfreich? Ja Nein


The REST adapter allows your store to communicate with an HTTP server by transmitting JSON via XHR. Most Ember.js apps that consume a JSON API should use the REST adapter.

This adapter is designed around the idea that the JSON exchanged with the server should be conventional.

Success and failure

The REST adapter will consider a success any response with a status code of the 2xx family ("Success"), as well as 304 ("Not Modified"). Any other status code will be considered a failure.

On success, the request promise will be resolved with the full response payload.

Failed responses with status code 422 ("Unprocessable Entity") will be considered "invalid". The response will be discarded, except for the key. The request promise will be rejected with a . This error object will encapsulate the saved value.

Any other status codes will be treated as an "adapter error". The request promise will be rejected, similarly to the "invalid" case, but with an instance of instead.

JSON Structure

The REST adapter expects the JSON returned from your server to follow these conventions.

Object Root

The JSON payload should be an object that contains the record inside a root property. For example, in response to a request for , the JSON should look like this:

Similarly, in response to a request for , the JSON should look like this:

Note that the object root can be pluralized for both a single-object response and an array response: the REST adapter is not strict on this. Further, if the HTTP server responds to a request to (e.g. the response to a query) with more than one object in the array, Ember Data will only display the object with the matching ID.

Conventional Names

Attribute names in your JSON payload should be the camelCased versions of the attributes in your Ember.js models.

For example, if you have a model:

The JSON returned should look like this:


Relationships are usually represented by ids to the record in the relationship. The related records can then be sideloaded in the response under a key for the type.

If the records in the relationship are not known when the response is serialized it's also possible to represent the relationship as a URL using the key in the response. Ember Data will fetch this URL to resolve the relationship when it is accessed for the first time.


If a response is considered a failure, the JSON payload is expected to include a top-level key , detailing any specific issues. For example:

This adapter does not make any assumptions as to the format of the object. It will simply be passed along as is, wrapped in an instance of or . The serializer can interpret it afterwards.


Endpoint path customization

Endpoint paths can be prefixed with a by setting the namespace property on the adapter:

Requests for the model would now target .

Host customization

An adapter can target other hosts by setting the property.

Some APIs require HTTP headers, e.g. to provide an API key. Arbitrary headers can be set as key/value pairs on the 's object and Ember Data will send them along with each ajax request.

can also be used as a computed property to support dynamic headers. In the example below, the object has been injected into an adapter by Ember's container.

In some cases, your dynamic headers may require data from some object outside of Ember's observer system (for example ). You can use the volatile function to set the property into a non-cached mode causing the headers to be recomputed with every request.

@mainName @ember-data/adapter/rest @tag main


Adaptor rest

Working with REST Adapter: A REST to SOAP Scenario in SAP PI/PO

Working with REST Adapter: A REST to SOAP Scenario in SAP PI/PO

Introduction:With the introduction of the REST Adapter in SAP PI/PO, consuming a REST service or exposing a REST service in PI becomes more fun. This is with respect to the fact that the SAP PI/PO ESB extends its capabilities to handle and process REST-based messages (XML, JSON) easily. Prior to this time, implementing or consuming a REST-based service had to be done via third party adapters (e.g Advantco) or manipulation of the AXIS Framework within SAP PI, which is often a tough task. In this blog, my aim is to highlight simple steps needed to expose a REST-based service in SAP PI/PO. An end-to-end implementation of simple REST to SOAP scenario is described.

Prerequisite:SAP NetWeaver 7.31 SP14 or SAP NetWeaver 7.40 SP 09 and above, knowledge of creating objects in Enterprise Service Repository and Integration Builder.

Scenario:The REST to SOAP scenario is implemented such that, an XML-based/JSON-based request is triggered from SOAP UI/Chrome REST Client. It is received by the Configured REST Adapter, processed and passed to the Receiver SOAP Adapter (configured to connect with the currency converter webservice

Figure: Exposing REST-based Service via SAP PI as shown in REST-to-SOAP Scenario diagram

ESR and Configuration Objects:In this scenario, the necessary ESR objects creation steps are only listed below, with more emphasis on the configuration.

ESR Objects:Create the following ESR objects

1)     Download the WSDL from:

2)     Import the WSDL as external definition in the sender and receiver namespaces

3)     Create the service interfaces for sender and receiver (use the same XSD on both sides)

4)     Create the message mappings and operation mappings

Directory Objects:Described below the necessary configurations steps for each object;

Sender REST Adapter:Create the Sender Communication channel by selecting the “REST Adapter” option.  Configure the REST Adapter as show below;

  • Input message format: XML
  • Quality of Service: Best Effort
  • Output message format: XML

Figure: Sender REST Adapter Configuration with input message as XML

Navigate to the “Channel Selection” and specify a URL path.  This is optional, but useful to distinguish the different scenarios exposing REST-based services in SAP PI, as this will be added in the URL of the sender application (in this case: SOAP UI).

Figure: Sender REST Adapter Configuration Endpoint

Receiver SOAP Adapter:Create the receiver communication channel and provide the necessary connection details to the currency converter webservice.

Figure: Receiver SOAP Adapter Configuration

Integrated Configuration: Configure the integrated configuration (ICO) using the sender and the receiver channels created earlier.

Test the Scenario with XML:To test the scenario, SOAP UI is used as the sender application. The endpoint URL to fire the message to is constructed as shown below;



Obtain a sample XML message from the test tab of the “Message Mapping” object in the ESR to be used as the XML to be sent from SOAP UI.

Figure: XML Request message from SOAP UI

Change The Sender Adapter Configuration (for JSON to XML conversion)

In addition to the above test, change the sender adapter configuration from XML to JSON, so that SAP PI receives a JSON request message from SOAP UI;

  • Input message format: JSON with the following additional configuration
  • Convert to XML
  • Add wrapper element
  • Element name (name of the request message as in the XSD in ESR)
  • Element namespace (namespace of the request as in the XSD in ESR)
  • Quality of Service: Best Effort
  • Output message format: XML

Figure: Sender REST Adapter Configuration with input message as JSON

Test the Scenario with JSON:To test the scenario, SOAP UI is used as the sender application. The endpoint URL to fire the message to is the same as in the previous test. The SOAP UI JSON request and response messages are shown below;

Figure: JSON Request from SOAP UI

Figure: JSON Request from Chrome REST Client

The results of the calls to consume the exposed REST service in SAP PI based on the REST adapter are also shown above in both test cases.

Conclusion:With this blog, I have been able to provide an insight into how to expose a REST service in SAP PI/PO using the REST Adapter as the sender communication channel. Additional settings of the adapter can also be used as well, e.g. sending a JSON message as input or output message.

Would you like to access Full Article?
If you are already a member in this website, Please Click here to loginIf you are not yet a member, Please Click here to Sign up  
if you have any questions don’t hesitate to contact us from the Button bellow

Contact US

New NetWeaver Information at

User Rating:Be the first one !

REST Adapter Capabilities When Consuming External REST APIs by Configuring the Connection as an Invoke

  • Enforces outgoing message and attachment size limitations:

    • Ensures that responses containing attachments for outbound REST requests do not exceed 1 GB. These attachments can be multipart/mixed, multipart/form-data, or application/octet-stream. If the attachment exceeds 1 GB, an HTTP error code message is returned:

    • Ensures that outgoing (invoke) messages returning an unstructured payload (multipart-formdata and binary/octed-stream) from a client do not exceed 1 GB in size.

    • Ensures that outgoing (invoke) messages returning structured message payloads (any content-type header containing JSON, XML, HTML, YAML, or YML) from a client do not exceed 10 MB in size.

  • Support for consuming any REST API described using Swagger 2.0/RAML/OpenAPI documents and the Oracle Metadata Catalog. The REST Adapter can automatically discover and present the available resources and operations present in the documents for configurations. The metadata regarding operation-specific request and response messages available in the document is automatically made available for mapping and other activities (see Swagger and RAML Document Support for Describing External REST APIs).

  • Supports configuration of the following (see Configuration Parameters):

    • Relative resource URI.

    • Support for HTTP methods GET, PUT, POST, DELETE, and PATCH.

    • Template and query parameters.

    • Support for a request/response payload:

  • Support for uploading sample XML documents to define the data definition for XML content during REST Adapterconfiguration. The following XML documents are supported for generating the data definition:
    • XML with no namespace.

    • XML with a homogenous namespace.

    • XML files up to 3 MB in size.

  • Support for uploading sample JSON documents to define data definitions during REST Adapter configuration.

  • Support for uploading complex XML schema definitions as a zipped archive to define data definitions for XML content during REST Adapter configuration (see Complex Schema Support).

  • Support for accessing and setting standard and custom HTTP headers exposed by external REST APIs (see Standard and Custom Header Support).

  • Support for multipart attachments (content-type: multipart/mixed, and multipart/form-data ) in request/response messages in an integration while sending a request to an external REST endpoint that accepts incoming request messages with multipart attachments and/or sends responses with multipart attachments (see Multipart Attachment Support for Trigger and Invoke Connections).

  • Support for consuming external REST APIs that are not described using Swagger/RAML/OpenAPI documents. You can declaratively specify the HTTP method and the sample JSON document/XML schema for describing the shape of the request and response messages.

  • Support for consuming REST APIs protected using HTTP Basic Authentication, OAuth Client Credentials (two-legged flow), OAuth Resource Owner Password Credentials (two-legged flow), OAuth Authorization Code Credentials (three-legged flow), OAuth Custom Three Legged Flow, OAuth Custom Two Legged Flow, OAuth 1.0a One Legged Authentication, Amazon Web Services (AWS) Signature Version 4, and Oracle Cloud Infrastructure (OCI) Signature Version 1. There is also support for consuming APIs that are unprotected.

  • Support for invoking external REST endpoints supporting the Amazon Web Services (AWS) Signature Version 4 authentication type.
  • Support for invoking Oracle Cloud Infrastructure cloud service REST APIs such as Oracle functions, streaming, storage and so on as an integral part of Oracle Integration orchestration flows.
  • Support for invoking co-located REST APIs in an optimized manner.

    The Oracle Integration runtime determines if the endpoint being invoked is co-located by checking if the endpoint URL has a load balancer address. If the endpoint URL has a load balancer address, the endpoint is considered co-located and the HTTP request is optimized by accessing the service locally using the non-SSL HTTP protocol.

  • Extensibility support to access plurality of OAuth 2 providers (see Standard and Custom Header Support).

  • Support for dynamically changing the (invoke) outbound endpoint configuration (see Support for Dynamic REST Endpoints).

  • Support for consuming external REST APIs that are protected using transport level security. The REST Adapter supports one-way SSL and two-way SSL. Oracle Integration supports a certificate management user interface to upload public certificates for external APIs that are protected either using lesser known certifying authorities (CA) or self-signed certificates.

    Support for external REST APIs hosted on a two-way SSL server requiring client side (Oracle Integration) identity. Oracle Integration provides support for exchanging the client side identity with the server hosting the external API.

  • Support for publishing of REST-based integrations as OpenAPI documents. OpenAPI support is available when configuring the REST Adapter as an invoke connection. You provide a link to the OpenAPI document to publish or consume.

    OpenAPI support enables you to perform the following tasks:

    • Publish an OpenAPI document describing an Oracle Integration REST endpoint. You can invoke the REST endpoint with the published document using a REST client such as postman.

      See Publish REST-Based Integrations as OpenAPI Documents.

    • Consume an OpenAPI document using the REST Adapter.

    OpenAPI-defined headers are automatically supported except for the standard headers that are currently disabled in the Adapter Endpoint Configuration Wizard.

  • Support for generating sample cURL syntax on the Summary page of the Adapter Endpoint Configuration Wizard for the configuration options that you have selected during REST Adapter connection configuration, such as security policy, headers, parameters, and so on. See Summary Page.
  • Sours:

    Now discussing:


    This document contains a description of the main features of FIXEdge's REST Transport Adaptor (REST TA), as well as common steps required for installation.


    FIXEdge REST adaptor is a REST server that handles REST requests with incoming messages in JSON form, converts them to FIX format and sends them to a given target. The adapter is designed for the generic processing of messages, without lock-in to specific message types.

    Depending on the configuration settings, the adaptor can transform incoming message to either a FIX XML message of 'n' type, or map JSON fields into FIX tags. The type of the resulting message should be defined in tag 35.

    The JSON message format might look as follows:

    '{"35":"D", "1":"12345", "56":"CITIGROUP", ..........}'

    The adaptor supports repeating groups and nested repeating groups.

    Requests are sent as HTTP POST requests to the following URL: http://<Address>:<ListenPort>/messages

    Example of REST request using curl for localhost and listen port 8001:

    curl -H "Content-Type: application/json" -X POST -d "{\"35\":\"D\",\"1\":\"USD\",\"386\":[{\"336\":\"ABCD\"}]}" http://localhost:8001/messages

    Resulting FIX messages can be optionally validated against FIX dictionaries defined in the configuration file.

    As a result of a REST request, the adapter should return one of the following HTTP status codes:

    • 200 - Success
    • 202 - Accepted, returned when a message is successfully received and parsed, but couldn't be delivered to the client in FE
    • 400 - HTTP error Bad Request (with JSON content including error message), in case of wrong input message or validation errors
    • 404 - HTTP error Not found for requests with the wrong URL

    Logging for received and send messages

    FIXEdge REST adaptor can be configured to write the following data into separate log file:

    • Content of input request
    • Resulting FIX messages
    • HTTP status returned to the caller

    Integration with FIXICC

    The adaptor supports the monitoring of its current state with FIXICC. It provides the following monitorable properties:

    • number of received messages
    • number of sent messages
    • number of rejected messages

    Description of JSON format for input messages:

    • Fields in input JSON message are listed as pairs of "FIXID":"FIXValue".
    • a JSON message can contain repeating groups represented as follows:

      { "NoRecordsID": [      { "FIXID":"FIXValue", "FIXID":"FIXValue"... },      { "FIXID":"FIXValue", "FIXID":"FIXValue"... }     ...    ] }

    Message Conversion Methods

    REST Acceptor TA supports two conversion methods:

    1. Raw (available since FIXEdge 6.9.0)
             a. Adapter accepts any FIX message
             b. Adapter routes FIX message to BL
    2. WrapInXmlMessage
      1. Adapter accepts any JSON
      2. Adapter creates FIX message 35=n (XML Message)
      3. Adapter stores received JSON as-is in tag 213 (XmlData)
      4. Adapter routes FIX message to BL
    3. NumericTagValueMapping
      1. Adapter accepts JSON, structured as described in JSON format for input messages section
      2. Adapter seeks tag-value pair "35":"XYZ" in incoming JSON
      3. If tag-value pair "35":"XYZ" is not found, or XYZ is not a valid FIX message type, adapter returns an error.
      4. The adapter creates empty FIX message with MsgType 35=XYZ
      5. For every tag-value pair in JSON corresponding tags/values are filled in FIX message by Adapter
      6. Adapter routes FIX message to BL

    Examples of input/output messages (pipe symbol stands for SOH symbol):

    input (from external system)output (to BL)


    8=FIX.4.4| 9=168| 35=E| 49=0| 56=RESTAdapter| 34=1| 50=30737| 66=List1| 116=OMS1| 52=20191101-11:11:01.080| 394=3| 68=2| 73=2| 11=0003| 67=1| 100=DSMD| 55=11| 54=1| 38=100| 11=0004| 67=2| 100=DSMD| 55=12|54=2| 38=200| 10=235

    FIX (input message is marked orange):

    8=FIX.4.4| 9=259| 35=n| 49=0| 56=0| 34=1| 52=20200317-10:23:55.068| 212=201| 213=8=FIX.4.4| 9=168| 35=E| 49=0| 56=RESTAdapter| 34=1| 50=30737| 66=List1| 116=OMS1|  52=20191101-11:11:01.080| 394=3| 68=2| 73=2| 11=0003| 67=1| 100=DSMD| 55=11| 54=1| 38=100| 11=0004| 67=2| 100=DSMD| 55=12| 54=2| 38=200| 10=235| 10=219


    JSON (the example contains repeating groups):

    {"66":"List1", "56":"RESTAdapter", "34":"3", "35":"E", "68":"2", "49":"JAVA", "394":"3", "116":"OMS1", "50":"30737", "52":"20150101-01:01:01.080", "73":[{"11":"0003", "55":"MSFT", "67":"1", "54":"1", "100":"DSMD", "38":"100"}, {"11":"0004", "55":"IBM", "67":"2", "54":"2", "100":"DSMD", "38":"200"}]}


    8=FIX.4.4| 9=184| 35=E| 49=JAVA| 56=RESTAdapter| 34=3| 50=30737| 116=OMS1| 52=20150101-01:01:01.080| 66=List1| 394=3| 68=2| 73=2| 11=0003| 67=1| 100=DSMD| 55=MSFT| 54=1| 38=100| 11=0004| 67=2| 100=DSMD| 55=IBM| 54=2| 38=200| 10=249

    FIX Message validation

    REST Acceptor TA can be configured to validate converted FIX messages. FIX Message validation uses the following default validation options:

    • prohibitTagsWithoutValue = true
    • verifyDataTagsSequence = true
    • verifyTagsValues = true
    • prohibitUnknownTags = true
    • prohibitDuplicatedTags = true
    • verifyRepeatingGroupBounds = true
    • checkRequiredGroupFields = true
    • allowZeroNumInGroup = false
    • ignoreUnknownFields = false

    Installation steps

    In order to set up REST TA for FIX Edge you need to:

    1.Copy the FIXEdge distribution package to the FIX Edge home:

    Unpack the content of the distribution package to the FIXEdge root directory, e.g. to C:\FIXEdge.

    2.Enable TA to be used by FIXEdge.

    In the ‘Transport Layer Section’ of the, add REST TA to the list of supported adapters:

    TransportLayer.TransportAdapters = TransportLayer.RestTA

    Note: If you use other transport adapters, just add TransportLayer.RestTA to the end of the list:

    TransportLayer.TransportAdapters = TransportLayer.SmtpTA, TransportLayer.RestTA

    3. Configure the TA.

    3.1.Add the REST TA section to the

    A sample set of properties is given below:

    TransportLayer.TransportAdapters = TransportLayer.RestTA TransportLayer.RestTA.Description = REST Acceptor TA TransportLayer.RestTA.DllName = bin/rest_acceptor_ta-vc10-MD-x64.dll TransportLayer.RestTA.Type = DLL TransportLayer.RestTA.ClientID = RestAcceptorClient TransportLayer.RestTA.LogCategory = RestAcceptorClient TransportLayer.RestTA.ListenPort = 8001 TransportLayer.RestTA.FIXVersion = FIX50 TransportLayer.RestTA.ConversionMethod = NumericTagValueMapping TransportLayer.RestTA.ValidateFIXMessage = ValidateAndWarn

    Note: Sample settings could be copied from the file (in the doc folder of FIXEdge distribution package) to the file.

    3.2.Optionally, configure logging for the received and sent messages in a separate log category:

    Log.RESTTA.Device = File Log.RESTTA.DebugIsOn = true Log.RESTTA.TraceIsOn = true Log.RESTTA.NoteIsOn = true Log.RESTTA.File.Name = FIXEdge1/log/RESTTA.log

    4.Restart FIXEdge to apply the changes.

    Routing Messages from REST TA

    The REST TA Client can be referred to the business layer (BL) by the ClientID name specified in the file. Below is an example of BL_Config.xml.

    <?xml version="1.0" encoding="UTF-8" ?> <!-- FIXEdge - the XML Configuration file $Revision: $ <!DOCTYPE FIXEdge SYSTEM "BusinessLayer.dtd"> --> <FIXEdge> <BusinessLayer> <Rule> <Source> <Client Name="RestAcceptorClient"/> </Source> <Condition> <MatchField Field="35" Value=" D|G|F|n " /> </Condition> <Action> <Send> <FixSession SenderCompID="FIXEDGE" TargetCompID="FIXCLIENT"/> </Send> </Action> </Rule> <DefaultRule> <Action> <DoNothing/> </Action> </DefaultRule> </BusinessLayer> </FIXEdge>

    REST TA Configuration Parameters

    Configuration of the REST Adaptor contains a list of adaptor properties, HTTP server properties, and log settings:

    Property NameDescriptionRequiredDefault Value

    Transport adapter parameters


    User-defined description of the Transport Adapter


    REST Acceptor TA


    TA library file name



    TA library type




    Transport adaptor Client ID which identifies the source of messages in BL config



    TCP port number for incoming HTTP connections. Allowed range is 1 - 65535




    FIX version of generated messages:

    • FIX40 - FIX 4.0
    • FIX41 - FIX 4.1
    • FIX42 - FIX 4.2
    • FIX43 - FIX 4.3
    • FIX44 - FIX 4.4
    • FIX50 - FIX 5.0
    • FIX50SP1 - FIX 5.0 SP1
    • FIX50SP2 - FIX 5.0 SP2




    The method used to convert input messages into FIX format:

    • WrapInXmlMessage - put the input data into FIX XML message of 'n' type
    • NumericTagValueMapping - parse the input JSON file format to corresponding FIX message
    • Raw- raw FIX message (FIX message is sent to BL as is)

      Introduced in FIXEdge 6.9.0




    Enables/disables validation of resulting FIX message:

    • No – validation disabled
    • ValidateAndWarn – validation enabled, a warning message is added to the log when validation fails
    • ValidateAndReject – validation enabled, service returns HHTP error 400 (bad request) and rejects the message if validation fails



    HTTP(S) Server Parameters


    Security type of connection. Allows user to setup secure or non-secure HTTP connection. 

    Introduced in FIXEdge 6.9.0

    • HTTP - non-secure connections 

    • HTTPS - secure connections 



    Connection timeout for HTTP connections in seconds.




    Enables/disables persistent HTTP connections:

    • false – persistent HTTP connections are disabled
    • true – persistent HTTP connections are enabled




    Specifies the maximum number of requests allowed during a persistent connection. 0 means unlimited connections.




    Connection timeout for persistent HTTP connections in seconds.




    A maximum number of threads processing HTTP requests. The allowed range is 1 – 16.




    Path to a private key

    Introduced in FIXEdge 6.9.0

    Required with secure connections:
    TransportLayer.RestTA.Protocol = HTTPS



    Path to certificate 

    Introduced in FIXEdge 6.9.0

    Required with secure connections:
    TransportLayer.RestTA.Protocol = HTTPS



    Private key passwordConditional
    Used when the private key is password-encrypted.

    Authentication header (may be used in HTTP mode also)

    Introduced in FIXEdge 6.9.0



    Authentication value (may be used in HTTP mode also)

    Introduced in FIXEdge 6.9.0


    Logging Parameters


    Transport adaptor log category



    The target device for logging the received and sent messages:

    • File – writes a log to a separate file
    • Console – sends a log to console window



    Filename used to log the received and sent messages


    Configuration example

    An example of REST Acceptor configuration with the security mode turned on:

    TransportLayer.RestTA.Description = RESTAcceptorTA TransportLayer.RestTA.DllName = bin/REST_Acceptor_TA-vc10-MDD-x64.dll TransportLayer.RestTA.Type = DLL TransportLayer.RestTA.ClientID = RestAcceptorClient TransportLayer.RestTA.LogCategory = RestAcceptorClient TransportLayer.RestTA.Protocol = HTTPS TransportLayer.RestTA.HTTPS.PrivateKey = FIXEdge1/conf/AdminRESTAPI.key TransportLayer.RestTA.HTTPS.Certificate = FIXEdge1/conf/AdminRESTAPI.crt TransportLayer.RestTA.ListenPort = 8001 TransportLayer.RestTA.FIXVersion = FIX44 TransportLayer.RestTA.ConversionMethod = NumericTagValueMapping TransportLayer.RestTA.ValidateFIXMessage = ValidateAndWarn TransportLayer.RestTA.AuthHeader = apikey TransportLayer.RestTA.AuthValue = QWERTY0123456789 TransportLayer.RestTA.PrivateKeyPassword = PKEYPASS123

    456 457 458 459 460