Getting started

To create a REST connector you go to Environment -> Connectors -> Add and select Type "REST Service".

Provide a 'Name' and click on "EDIT" to get started. You will also be required to provide a base address before you can save the connector.

When you click on "EDIT" you will open a tool where you'll define the connector.

Let's walk through all the properties.


  • Connector name This is just what you want to call the connector.

  • Connector description A description of the connector. For documentation purposes.

  • Base path If set, all paths are prepended with the value of 'Base path'. If for example the base address of the connector (set not in the tool but in connector configuration) is '' and 'Base path' is set to '/drive/v3' and you define the operation 'about' with 'Path' '/about' the url called in runtime will be ''

  • Connector version For documentation purposes.


The main purpose of containers are to help you organize the operations in a logical way. You do not need to specify any containers, but it usually make senses to use them. Containers can contain operations and other containers. They can also define 'Standard headers' that can be applied to all sub-containers and operations. Containers can also define a 'Path' which is appended to the 'Base path' (described above). The final 'Path' of an operation is the concatenation of all parent containers 'Path' (can be overridden).


In the 'Operations' section you can add and delete operations of the connector. This is most likely the first thing you will do when starting a new REST Connector project.

Standard headers

In this section you can specify entity, general, request and response headers that should be applied to all operations of connector. You can for instance set that all operations must send 'Content-Type: application/json'. Sub-containers and operations can always override the header.


In this section you can specify what xml serializer to use (not common that this has to changed) and also error handling. In the error handling section you can choose to enforce input validation (e.g. a maximum value of an integer parameter) and whether or not the connector should escalate errors in runtime or suppress them. If you select to suppress ('Throw on error' is not selected) the resulting record of a REST operation will contain additional members with information whether the operation failed or not.

Last updated