Developer ToolsFree generatorPDF, Excel, Word exportOracle PeopleSoftAll Oracle PeopleSoft tools

PeopleSoft REST API Request Generator for RESTListeningConnector

This generator builds the request a client sends to a PeopleSoft REST service operation through the Integration Broker gateway: the RESTListeningConnector URL, headers, body and a curl command. It also gives the OnRequest handler skeleton the operation needs on the PeopleSoft side.

Fill in

Gateway base URL

Default local node

REST service operation

Operation version

URI template values

Resolved URI template, for example EMPLID/{EMPLID} becomes EMPLID/KU0001.

HTTP method

PeopleSoft user ID

JSON body (POST/PUT)

Generated code

Download:

HTTP request

GET https://ps.example.com/PSIGW/RESTListeningConnector/PSFT_HR/CUSTOM_GET_EMPLOYEE.v1/EMPLID/KU0001 HTTP/1.1
Authorization: Basic <base64 of INTUSER:password>
Accept: application/json
Content-Type: application/json

{
  "EMPLID": "KU0001",
  "PHONE": "555-0100"
}

curl

curl -X GET "https://ps.example.com/PSIGW/RESTListeningConnector/PSFT_HR/CUSTOM_GET_EMPLOYEE.v1/EMPLID/KU0001" \
  -u "INTUSER:YOUR_PASSWORD" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{
  "EMPLID": "KU0001",
  "PHONE": "555-0100"
}'

# For GET and DELETE, remove the --data line.

OnRequest handler skeleton (application class, PeopleCode)

import PS_PT:Integration:IRequestHandler;

class RestHandler implements PS_PT:Integration:IRequestHandler
   method OnRequest(&MSG As Message) Returns Message;
   method OnError(&MSG As Message) Returns string;
end-class;

method OnRequest
   /+ &MSG as Message +/
   /+ Returns Message +/
   Local Document &uriDoc;
   Local string &key;
   Local Message &resp;

   &uriDoc = &MSG.GetURIDocument();
   &key = &uriDoc.DocumentElement.GetPropertyByName("EMPLID").Value;

   &resp = CreateMessage(Operation.CUSTOM_GET_EMPLOYEE, %IntBroker_Response);
   /* build the response document or content here */
   Return &resp;
end-method;

method OnError
   /+ &MSG as Message +/
   /+ Returns String +/
   Return "Error in CUSTOM_GET_EMPLOYEE";
end-method;

The URL pattern is the PeopleTools 8.5x and 8.6x REST listening connector. The URI template property name (EMPLID here) must match the template you defined on the service operation. Confirm the gateway host and port, the default local node name (PeopleTools > Integration Broker > Integration Setup > Nodes), and that the service operation is active with an any-to-local routing.

Exposing PeopleSoft data over REST?

Send us the data you need to expose and we will outline the service operations, security and handler design.

Optional. The tool and every export work without this. No spam.

Was this tool useful?

How the URL is built

Inbound REST calls go to the integration gateway at /PSIGW/RESTListeningConnector/, followed by the default local node of the target database, then the service operation name and version joined by a dot, then the resolved URI template. For example https://ps.example.com/PSIGW/RESTListeningConnector/PSFT_HR/CUSTOM_GET_EMPLOYEE.v1/EMPLID/KU0001. The method must match the REST method defined on the operation; a service operation is defined per method, so a GET and a POST on the same resource are separate operations. The Integration Broker service operation page shows the generated URL on its REST resource definition, which is the quickest way to check yours.

Node: your default local node, not the remote client node.
Version: the service operation version name, usually v1.
URI: one of the URI templates defined on the operation.

Setup checklist on the PeopleSoft side

Create a REST service, then a REST service operation with the method, URI templates (for example EMPLID/{EMPLID}) and request and response messages or documents. Add a handler of type OnRequest that points at your application class implementing PS_PT:Integration:IRequestHandler. Save with the any-to-local routing generated and confirm the routing is active. Grant the service operation on a permission list (Web Services tab, full access) for the user the client authenticates as. Make sure the gateway is configured and the default local node pings.

Without credentials, Integration Broker runs the request as the default user ID of the ANONYMOUS node, so set that node carefully or require authentication.
Use HTTPS on the gateway; Basic authentication sends the password on every call.

Troubleshooting

A 404 from the gateway usually means the node, operation or version in the URL does not match, or the URI does not match any template. A 401 or a security error means the user lacks the service operation on a permission list. A 500 with a PeopleCode error points to your handler; check the Integration Broker message log and the gateway errorLog.html and msgLog.html. Synchronous transactions appear in Service Operations Monitor under synchronous details when logging is enabled on the routing.

Frequently Asked Questions

What is the PeopleSoft REST API URL format?

https://<gateway host>/PSIGW/RESTListeningConnector/<default local node>/<service operation>.<version>/<URI template values>. For example /PSIGW/RESTListeningConnector/PSFT_HR/CUSTOM_GET_EMPLOYEE.v1/EMPLID/KU0001. The service operation page in Integration Broker shows the generated REST URL for each URI template.

How do I send a POST to a PeopleSoft REST service?

Define a REST service operation with method POST and a request message, then send the JSON body with Content-Type application/json to the same URL pattern. In the handler, read the request content from the Message object, process it, and return a response message created with CreateMessage(Operation.NAME, %IntBroker_Response).

Does PeopleSoft have a built-in REST API?

PeopleSoft provides the Integration Broker framework to publish your own REST service operations, and many applications deliver REST services for specific features, such as Fluid and mobile functions. There is no single generic CRUD API over all tables; you expose what you need through service operations, Component Interfaces or delivered services.

Which user does an anonymous REST call run as?

When a REST request has no credentials, Integration Broker uses the default user ID defined on the ANONYMOUS node. That user then needs the service operation on a permission list. Most sites require Basic authentication or tokens instead, so the call runs as a named integration user.

If you want your team to query PeopleSoft through a private AI assistant that calls approved REST operations on your own servers, we can build that layer.

Talk to an Expert Explore More Free Tools