Publishing REST Web Services

A REST Web service publishes a set of views and associations and makes them available to external applications that cannot use the JDBC or ODBC interfaces.

REST Web services provide similar features and work pretty much in the same way as the RESTful Web service described in the section RESTful Web Service (i.e. the service at However, there are a few features that the REST web services have and the RESTful web service do not:

  • Define an API with a set of views instead of all the views created in Virtual DataPort.

  • A REST web service provides an OpenAPI document (more information in the next page - Settings Tab (REST)).

  • To publish a web service that does not require authentication (the RESTful web service always requires authentication because it gives access to any view created in Virtual DataPort).

  • Set mandatory input fields.

  • Support for RSS.

To create a REST Web service, right-click on the view you want to publish, in the Server Explorer and click REST Web service on the menu New > Data service or click REST Web service in the menu File > New > Data service.

The “Create REST Web service” dialog has the following tabs:

  • Resources: lists the views and associations published by the Web service. You can add more by dragging a view. See section Resources Tab.

  • Settings: manages the configuration of the REST Web service. See section Settings Tab (REST).

    There are additional settings that are global to all the REST web services (see Global Settings of REST Web Services) so they are managed in Server Configuration, not in the Settings tab of each service.

  • Advanced: manages the parameters of the connection between the Web service and the Virtual DataPort Server and other advanced settings. See section Advanced Tab (REST).

  • Metadata: select the target folder of the Web service and provide a description for it.

After configuring everything, click Save to create the Web service. The Tool will display the “Web service container status” table that lists the existing Web services. Then, you can deploy the Web service in the embedded Web container or generate the war file and deploy it in an external Web container (see section Web Service Container Status Table).


If you logged in to Virtual DataPort with Kerberos authentication or any other single sign-on method and you publish a web service that has one of the following authentication modes, deploy the web service specifying the credentials (user/password) of another account (e.g. a service account) that has the necessary privileges to query the views published by this web service:

  • No authentication

  • HTTP Basic

  • HTTP Digest

Add feedback