REST Services

Use this page to configure Representational State Transfer (REST) services for a particular server or cluster or for business processes or human tasks on a server or cluster.

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

For REST services other than business processes and human tasks:
For business process REST services:
For human task REST services:
Note: If you want to configure all REST services in your environment, use the REST services page available by clicking Services > REST services > REST services.

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 will be used to form the 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 server or 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.

Enabled

In the table, select the check box to enable the REST service. Clear the check box to disable the REST service.

Type

This column lists a short description of the type of REST service that you are configuring. This field is read-only.

Description

Modify the description, which describes the purpose of the REST service.

URL

This field lists the full URL path for available REST services. This field is read-only.