Web Service Browser

The Web Service Browser has the following features:
  • an interactive console to test the RESTful web services
  • an API reference that describes how to invoke the RESTful web services
  • a help page

Use the system properties page to configure if the Web Service Browser is enabled, disabled, or provides documentation only.

Interactive console

Start the RESTful web services using the Web Service Browser:

  1. Log in to the Common Services user interface.
  2. Open the following URL: 
    https://server:portnumber/ws/svc

    where

    • server represents the server name, for example 'localhost'.
    • portnumber represents the port number for Common Services.
Figure 1. Sample Web Service Browser interactive console
gpyiybr_wsbrowser_services_msgstd.jpg
Note:
  1. Do not use any runtime parameters in the interactive console or you get unexpected errors.
  2. Only one session per web browser is supported. Switching between the Web Service Browser and the FTM Console within this session is not supported.

API reference

The Web Service Browser has an API Reference tab that describes the details of the preconditions and input values that are needed to invoke the web service. It also describes the fields that are returned as the response, or output.

Figure 2. Sample Web Service Browser API reference
gpyiybr_api_reference_withoutsecurity.jpg

Help

The Web Service Browser has a help button that provides information about the options that can be used with the URI that calls the web services.

The help page is also accessed by using the following URI: 
/ws/svc/help
Figure 3. Sample Web Service Browser help
gpyiybr_help.jpg