Skip to main content

Configuring a Web Application for the Public Service Registry REST API

Configuring a Web Application for the Public Service Registry REST API

This section describes how to configure a web application for the Public Service Registry REST API.

  1. Define a web application that will handle calls to the Web port. The web application name defines the root of the URL that will call the service. A single web application can support multiple business services but they must all have a class that is the same or a subclass of the web application dispatch class.

    1. Select System Administration > Security > Applications > Web Applications to display the Web Applications portal page. Click Create New Web Application.

    2. Name the web application, such as /services. You must start the name with a / (slash) character. All alphabetic characters in the name should be in lower case.

    3. Set the Namespace to the namespace that the service registry is running in, such as SERVICESNS. Leave the Namespace Default Application unchecked.

    4. Select the Inbound Web Services check box.

    5. Leave the Resource Required and Group By ID fields empty.

    6. If you want the registry to be accessed by users who log in, select the Allowed Authentication Methods Password check box. If you want the registry to be accessed by users without logging on, select the Unauthenticated check box.

    7. Set the Dispatch Class to the Ens.ServiceRegistry.API.REST.QueryOpens in a new tab component class.

    8. Select Save.

    9. Click the Application Roles tab.

    10. In the Available box, select the following roles:

      • %EnsRole_RegistrySelect

      • Roles defined for the namespace’s globals and routines databases, such as %DB_SERVICESNSG and %DB_SERVICESNSR.

      • Any role defined for the Public Service Registry that you want to be available to all users regardless of the account they use to log in. If you are configuring the web application to allow unauthenticated access, you must specify at least one of these roles.

      You can select multiple roles while holding the Ctrl key.

    11. After the roles are highlighted, click the right-arrow button to move them to the Selected text box.

    12. Then click Assign.

Note:

If your web application allows both unauthenticated and authenticated service, then it will prompt for a password, but if you do not enter a password, the web applications grants you unauthenticated access.

FeedbackOpens in a new tab