REST Services

Use this page to configure services for Representational State Transfer (REST) application programming interfaces (APIs). If you want REST APIs available during run time, you must configure the REST services. If you want widgets to be available in Business Space, you must configure the REST services for those widgets.

To view this administrative console page, click one of the following:

For servers, click: Servers > Server Types > WebSphere application servers > name_of_server > Business Integration > REST Services.

For clusters, click: Servers > Clusters > WebSphere application server clusters > name_of_cluster > Business Integration > REST Services.

For the Deployment Environment Configuration wizard, click: Servers > Deployment Environments > New and complete each preceding configuration page. This page appears for the REST Services step.


Links marked (online) require access to the Internet. Each link launches a search for the topic in the online information center. When search results are listed, select the topic that corresponds best to your configuration.

Check for updates to this topic (online)

Protocol

Select either http:// or https://, which is used to form the endpoint address for all the REST services on this page. Configure a full URL path by selecting http:// or https:// and then setting the host and port. In an environment with a load balancer or proxy server between the browser and the Business Space and REST services, make sure that what you designate here matches the browser URL for accessing Business Space.

Host name or virtual host in a load-balanced environment

Type the host or virtual host that a client needs to communicate with the cluster. Use a fully qualified host name. In an environment with a load balancer or proxy server between the browser and the Business Space and REST services, make sure that what you designate here matches the browser URL for accessing Business Space. If you are using the Deployment Environment Configuration wizard, and you leave the host and port fields empty, the values default to values of an individual cluster member host and its HTTP port. For a load-balanced environment, you must later change the default values to the virtual host name and port of your environment.

Port

Type the port for all REST services that you want to configure. For a load-balanced environment, designate the port number that the client needs to communicate with the cluster. In an environment with a load balancer or proxy server between the browser and the Business Space and REST services, make sure that what you designate here matches the browser URL for accessing Business Space. If you are using the Deployment Environment Configuration wizard, and you leave the host and port fields empty, the values default to values of an individual cluster member host and its HTTP port. For a load-balanced environment, you must later change the default values to the virtual host name and port of your environment.

Context root

This field lists the context root for the REST service provider. This field is read-only.