Understanding Creating Component Interface-Based REST Services

PeopleSoft Integration Broker enables you to take an existing component interface and create a REST-based service that can be used to invoke the component interface. Further, it creates service operations, including request messages and response messages (if appropriate). The system creates an inbound any-to-local routing for the service operation version, as well as handlers for each method you choose to include in the service.

All service operations you generate from component interfaces are synchronous service operations.

This feature allows you to:

  • Create services for selected component interfaces.

  • Add selected methods to existing REST services previously created using this component.

  • Compare selected component interfaces with the REST services previously created using this component.

This section highlights the naming conventions that the PeopleSoft system uses when it creates REST services and services-related data based on component interfaces.

When it creates a web service from a component interface, the PeopleSoft system adds a CIRT_ prefix to the component interface name. So if the component interface name is MYCI, the service name the system creates is CIRT_MYCI.

The following table highlights naming conventions the PeopleSoft systems applies to other service data based on the method with which you are working:

Component Interface Method

Service Operation Name

Message Name

Component Interface Handler

Request Message Shape

Response Message Shape

Create

CIRT_<CI Name>_C_POST

Mxxxxxx

ONREQUESTHDLR

CI Buffer structure

Object Key

Get

CIRT_<CI Name>_G_GET

Mxxxxxx

ONREQUESTHDLR

Get Keys

CI Buffer

Find

CIRT_<CI Name>_F_GET

Mxxxxxx

ONREQUESTHDLR

Find Keys

Find Key Collection

Update

CIRT_<CI Name>_U_PUT

Mxxxxxx

ONREQUESTHDLR

CI Buffer structure

Notification, error details

Update Data

CIRT_<CI Name>_UD_PUT

Mxxxxxx

ONREQUESTHDLR

CI Buffer structure

Notification, error details

Note: The maximum number of characters for a service operation name is 30.

If a user modifies or deletes a component interface in PeopleSoft Application Designer, when the user saves the changes, PeopleSoft Integration Broker checks if a service exists for the component interface. If a service exists, and the component structure or properties have changed in the component interface, a warning message appears stating that a service exists for the component interface.

If the component interface structure changes, a status of Does not match appears in the CI-Based REST Services Review Status grid, and the operation appears as active in the Service Operations component.