Author Info

Chris Malek

Chris Malek is a PeopleTools® Technical Consultant with two decades of experience working on PeopleSoft enterprise software projects. He is available for consulting engagements.

About Chris Work with Chris

Looking for pain-free PeopleSoft web services? 😀

PeopleSoft Simple Web Services (SWS)

Introducing a small but powerful PeopleSoft bolt-on that makes web services very easy. If you have a SQL statement, you can turn that into a web service in PeopleSoft in a few minutes.

RESTListeningConnector

The RESTListeningConnector is the listener you use if you are invoking REST services on PeopleSoft. This listener was introduced in PeopleTools 8.53.

The URL pattern is: https://host:port/PSIGW/RESTListeningConnector/{target-node}/{service-operation-name-and-version}/{optional-template-and-parameters}

The general characteristics of this listener are:

There is no concept of a node.
The service being invoked is in the URL path
Parameters can be in both the URL path and payload.
The only HTTP Header is the Authorization header.

Passing Parameters

All parameters to identify the node and and service operation and often parameters are passed as part of the URL.

https://{host}/PSIGW/RESTListeningConnector/{target-node}/{service-operation-name-and-version}/{template-and-parameters}

HTTP Method	Parameters in Path?	Parameters in Query String	Parameters in HTTP Body
GET	Yes	Yes	NO - HTTP Body allowed
POST	Yes	Yes	Yes
PUT	Yes	Yes	Yes
DELETE	Yes	Yes	NO - HTTP Body allowed

HTTP Return Codes

Unlike the HTTPListeningConnector, Returns codes are used and should be meaningful. Take a look at REST Status Code Chapter

HTTP Headers

Inbound Headers

Unlike the HttpListeningConnector, the parameters are NOT passed in the headers. The only inbound header is the authorization header.

Authorization - If you have authentication on your API, then the only HTTP Header should be the authorization header. See the REST Security Chapter for full details on that.

A client can add any number of HTTP Headers to the request and they can be parsed by the handler code. You can view some examples of that in the Code Snippets chapter

Outbound Headers

The RESTListeningConnector will return some limited HTTP response headers.

The headers returned by the handler are:

Connection
Date
Content-Length
Content-Type
Content-Encoding

The handler can add any number of custom headers and those can be viewed in the Code Snippets chapter

Security Options

Security for the RESTListeningConnector is covered in the REST Security Chapter