The RESTListeningConnector is the listener you use if you are invoking REST services on PeopleSoft. This listener was introduced in PeopleTools 8.53.
https://host:port/PSIGW/RESTListeningConnector/{target-node}/{service-operation-name-and-version}/{optional-template-and-parameters}The general characteristics of this listener are:
node.Authorization header.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 |
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
The RESTListeningConnector will return some limited HTTP response headers.
The headers returned by the handler are:
ConnectionDateContent-LengthContent-TypeContent-EncodingThe handler can add any number of custom headers and those can be viewed in the Code Snippets chapter
Security for the RESTListeningConnector is covered in the REST Security Chapter
Chris Malek is a PeopleTools® Technical Consultant with over two decades of experience working on PeopleSoft enterprise software projects. He is available for consulting engagements.
Work with ChrisSWS turns SQL into production REST APIs — ready for AI, modern apps, and partner integrations. One install, unlimited potential.
A powerful PeopleSoft bolt-on that makes REST web services easy. You bring the SQL, SWS handles the rest.
Traditional PeopleSoft web services cost $3,600–$13,000 each to develop. SWS deploys production REST APIs in under 5 minutes through configuration alone.
Turn PeopleSoft data into clean REST APIs for AI integrations, modern applications, and vendor data feeds. Configuration-driven — no PeopleCode required.