Adding REST Service Definitions
This section discusses how to add REST service definitions to the PeopleSoft system.
REST service names and REST service alias names can be exposed as REST services. As a result, the following restrictions apply when you name a REST service or a REST service alias. REST service names and REST service alias names:
Cannot begin with XML, xml, or Xml.
Cannot begin with a digit.
Cannot begin with a character.
To add a REST service definition to the system, use the Add New Service page (IB_SERVICE_ADD). To access this page, select , then select the Add a New Value link.
Image: Add New Service page
This example illustrates the Add New Service page.
Note: Before you can add a service, you must configure PeopleSoft Integration Broker to handle services using the Service Configuration page.
See Understanding Configuring PeopleSoft Integration Broker for Handling Services.
Important! To create a REST service you must select the REST Service option when you add the service.
After you add a service definition to the system, the Services page (IB_SERVICEDEFN) appears that you use to configure the service definition.
Image: Services page
This example illustrates the Services page. The example shows that a REST-based service definition called DEMO_REST_SERVICE has been added to the system. Note that the REST Service check box at the top of the page is checked, signifying that the service is REST-based.
To add and configure a REST service definition:
Access the Services page ().
Click the Add a New Value link.
In the Service field, enter a name for the service.
Restrictions for naming services are discussed elsewhere in this section.
See Understanding Naming Services and Service Aliases for REST Service Definitions.
Select the Rest Service check box.
Click the Add button.
The Services page appears.
In the Description field, enter a description for the service.
(Optional.) Select the Is Provider check box to define the service as a provider service.
By default, when you add a REST-based service to the system it is a provider service.
(Optional.) In the Comments field, enter comments about the service or the service.
(Optional.) In the Service Alias field, enter an alias name for the service.
Restrictions for naming service aliases are discussed elsewhere in this section.
See Understanding Naming Services and Service Aliases for REST Service Definitions.
(Optional.) From the Object Owner ID drop-down list box, select the owner of the service.
In the Namespace field, enter a namespace URI for the service.
The default value is the namespace that is declared in the Service Namespace field on the Service Configuration page.
Click the Save button.