PeopleSoft REST services

PeopleSoft Rest Service
 

 

Here is a step by step example of how to create a REST service in PeopleSoft. 

The first example passes one row of data via the URL. The response includes multiple po lines. 

The second example passes JSON in the body with no parameters in the URL. The response is one row per row in the request.

 

1)    Create template document for inbound parameter(s) (the request).

1)    One or more element names.

2)    Create a view record of the outbound data (the response).

3)    Create template document.

1)    Element names, Collections and Compounds.

2)    Map the document elements to fields in your view

4)    Link messages to document

5)    Create your response message which structures your response.

6)    Create a REST Service

7)    Create your Service Operation

8)    Create your service operation handler application package. This is the PeopleCode that will trigger and will respond to the incoming request and return something useful to the client.

9)    Link your service operation handler to the application class.

10)  Setup the security of the web service.

11) Bonus: Pass JSON in the body example.

 

 

The REST service will be invoked by a URL like this:

https://peoplesoft.domain.com:9999/PSIGW/RESTListeningConnector/PSFT_EP/FS_FS_PO.v1/?PO_ID=1234567890

The ? begins the parameter list. In our case there is one. If you were to create multiple parameters each would be separated by an &. Like this:

https://peoplesoft.domain.com:9999/PSIGW/RESTListeningConnector/PSFT_EP/FS_FS_PO.v1/?BUSINESS_UNIT=POBU&PO_ID=1234567890

There are several pieces to the URL:

peoplesoft.domain.com - This is the hostname. It is not accessible to the internet.

PSIGW - Standard Integration Gateway path

RESTListeningConnector - REST connector that accepts REST web services.

PSFT_EP - The node name that I am directing this service to. This will differ based on your installation.

FS_FS_FS.v1 - The service operation name and version we will create

BUSINESS_UNIT and PO_ID - are the parameters.

• Build a document object that will capture all the parameters that may be sent inbound to your web service. This is the request.
• We are building parameters in this document. The parameter will be in the URL. So, we are only passing 1 row of data. 
• The document can only contain primitive elements and collection elements.
• The document cannot contain any imports (compounds) or compound elements. In this example there is one parameter: PO_ID. It is created as a document primitive (blue star).

Build view of the data to be sent in response

Not required to build a view; it’s useful to retrieve the data for the response

Build a document object that will capture the parameters that will be sent outbound from your web service; this is the response.

Create a message that will be used to return the XML or JSON from the service

In this example, we create a collection for multiple lines; Note: You need a collection if returning multiple rows.

When we are done creating the lines this is what it will look like.

Add a collection peer (green dots)

Add a compound peer (Red connected dots)

Add primitive peers (blue star) for each field in your response. Define the type. 

The detail steps are below

1st Create a document for the line fields
First we create a document for the line fields
1st Time Give Package a Name. In our case DCP_DocumentPackage_PO
Give the Document a name: DCP_FS_PO_LN
And a Version V1
We are building from the inside out. Details 1st then header.
We are going to add this document to a collection.
Again add a primitive child and primitive peers for each field for the lines in the response.
Choose a type (decimal) for each and a length (10 and in this case also the number of decimals 4)

Map fields to view 

Mapping PeopleSoft records and fields to documents is optional.

Usually done to populate a rowset using a document; rowset is not used in our example

Enter the view you created in the record name.

Chose the field that matches your primitive.

Note the XML element and JSON tags; your response can be either

Create a collection peer

Create a new document for the same package

Add a Collection Peer (Green dots).

Add Compound Peer (Connected red dots) to add child document

The Package will default

Enter the document

Enter the version

Search

Select your result

Then create header

We’ve created the lines

Now create the header.

Add Primitive peers for each field (blue stars).

Then add collection for lines. This allows for multiple rows.

Add Compound Peer (connected red dots) to add child document much like we added PO_LINE_LIST – DCP_FS_PO_LN

Click the connected red dots and this appears. 

Document DCP_PO_LINES

Click Search and chose the results

End result will look like this.

Create message and map to document

Build a message object based on the document template built earlier

PeopleTools > Integration Broker > Integration Setup > Messages
Choose Add New Message
Choose Type = “Document”
Enter message name and then input the package document package and name
Do this for both the request and the response

    This example is for the request DCP_FS_PO_ID.

    You’ll need to do it for the response too DCP_FS_PO.

Create the service

• Give it a name, be sure REST Service is checked 

• click Add.

Service Operation

Create the service operation

Give the Service Operation a Name

Choose the REST Method. In this example, “Post” is chosen; Note: This will be appended to the name

Click Save

Click Add

Create the service operation

Add parameters for the template

Add the Messages (Documents) for your request, response and optionally fault (error)

    These are the message we created which are tied to the documents we created.

This is why we link the message to the document, so we can put the message here

Choose the content type.

    Note: I chose the content type application/JSON because I want my response to be JSON.

Create the Application Package:Application Class. This is the code that will populate the response.

import PS_PT:Integration:IRequestHandler;

class DCP_FS_PO_POST implements PS_PT:Integration:IRequestHandler  

method OnRequest(&_MSG As Message) Returns Message;

method OnError(&pRequestMsg As Message) Returns string;end-class;

method OnRequest
   /+ &_MSG as Message +/
   /+ Returns Message +/
   /+ Extends/implements PS_PT:Integration:IRequestHandler.OnRequest +/
   Local Message &returnMsg;
   Local Document &returnDoc;
   Local Compound &returnCom, &returnCom2, &aComLn;
   Local Collection &returnColl;
   Local boolean &ret;
   Local DocumentKey &docKey;
   Local Primitive ≺
   Local string &sCriteria;      

/* This is the view mapped to the document */

Local Record &POVndrRec = CreateRecord(Record.DCP_PO_REST_VW)

/* Build the select */

&POVndrRec.PO_ID.Value = &PO_id;

&sCriteria = " WHERE PO_ID = '" | &POVndrRec.PO_ID.Value | "'";

Local string &POVndrSQL_Str = "%SelectAll(:1)" | &sCriteria;

   
   /* Populate document with inbound message values from URI*/
   Local Document &PODoc = &_MSG.GetURIDocument();
   /* This would retrieve the http content body as a string. Normally either JSON or XML*/
   
   /* Get the PO id from the inbound document */
   Local string &PO_id = &PODoc.GetElement("PO_ID").value;
   
   Evaluate &_MSG.HTTPMethod
   When = %IntBroker_HTTP_POST
      
      /* Fetch PO and Vendor details from DCP_PO_REST_VW */
      Local Record &POVndrRec = CreateRecord(Record.DCP_PO_REST_VW);
      /* Build the select */
      &POVndrRec.PO_ID.Value = &PO_id;
      &sCriteria = " WHERE PO_ID = '" | &POVndrRec.PO_ID.Value | "'";
      Local string &POVndrSQL_Str = "%SelectAll(:1)" | &sCriteria;
      rem MessageBox(0, "", 0, 0, "POVndrSQL = " | &POVndrSQL_Str);
      
      Local SQL &SQL_PO_Vndr = CreateSQL(&POVndrSQL_Str, &POVndrRec);
      
      /*Construct response message */
      &returnMsg = CreateMessage(Operation.DCP_FS_PO_POST, %IntBroker_Response);
      &returnDoc = &returnMsg.GetDocument();
      &returnCom = &returnDoc.DocumentElement;
      
      /*Get 1st Row (for header ) */
      
      Local boolean &Found = &SQL_PO_Vndr.Fetch(&POVndrRec);
      
      &pr = &returnCom.GetPropertyByName("BUSINESS_UNIT");
      &pr.Value = &POVndrRec.BUSINESS_UNIT.Value;
      &pr = &returnCom.GetPropertyByName("PO_ID");
      &pr.Value = &POVndrRec.PO_ID.Value;
      &pr = &returnCom.GetPropertyByName("PO_STATUS");
      &pr.Value = &POVndrRec.PO_STATUS.Value;
      &pr = &returnCom.GetPropertyByName("VENDOR_ID");
      &pr.Value = &POVndrRec.VENDOR_ID.Value;
      &pr = &returnCom.GetPropertyByName("NAME1");
      &pr.Value = &POVndrRec.NAME1.Value;
      &pr = &returnCom.GetPropertyByName("NAME2");
      &pr.Value = &POVndrRec.NAME2.Value;
      &pr = &returnCom.GetPropertyByName("VENDOR_CLASS");
      &pr.Value = &POVndrRec.VENDOR_CLASS.Value;
      /* Could return multiple rows */
      While (&Found)
         
         /* Get the child compound element */
         &returnCom2 = &returnCom.GetPropertyByName("DCP_PO_LINES");
         /* Get the child collection element */
         &returnColl = &returnCom2.GetPropertyByName("PO_LINES_LIST");
         /*create a new compound (DCP_FS_PO_LN) and set the values of each primitive*/
         &aComLn = &returnColl.CreateItem();
         
         &pr = &aComLn.GetPropertyByName("QTY_OPEN");
         &pr.Value = &POVndrRec.QTY.Value;
         &pr = &aComLn.GetPropertyByName("INV_ITEM_ID"); /* DCP Part # */
         &pr.Value = &POVndrRec.INV_ITEM_ID.Value;
         &pr = &aComLn.GetPropertyByName("DESCR254_MIXED");
         &pr.Value = &POVndrRec.DESCR254_MIXED.Value;
         &pr = &aComLn.GetPropertyByName("VNDR_CATALOG_ID"); /* Vendor Part */
         &pr.Value = &POVndrRec.VNDR_CATALOG_ID.Value;
         &pr = &aComLn.GetPropertyByName("OPEN_AMT");
         &pr.Value = &POVndrRec.OPEN_AMT.Value;
         &pr = &aComLn.GetPropertyByName("MERCHANDISE_AMT"); /* Line Total */
         &pr.Value = &POVndrRec.MERCHANDISE_AMT.Value;
         &pr = &aComLn.GetPropertyByName("PRICE_PO"); /*Item Price */
         &pr.Value = &POVndrRec.PRICE_PO.Value;
         &pr = &aComLn.GetPropertyByName("DEPTID"); /*RC Code */
         &pr.Value = &POVndrRec.DEPTID.Value;
         &pr = &aComLn.GetPropertyByName("LINE_NBR");
         &pr.Value = &POVndrRec.LINE_NBR.Value;
         &pr = &aComLn.GetPropertyByName("SCHED_NBR");
         &pr.Value = &POVndrRec.SCHED_NBR.Value;
         &pr = &aComLn.GetPropertyByName("UNIT_OF_MEASURE");
         &pr.Value = &POVndrRec.UNIT_OF_MEASURE.Value;
         /* Concatenate multiple rows of the child entity and maintain the one to many relationship */
         &ret = &returnColl.AppendItem(&aComLn);
         &Found = &SQL_PO_Vndr.Fetch(&POVndrRec)
      End-While;
      
   When-Other
      /* throw error conditin */
      throw CreateException( - 1, - 1, "Invalid call %1", String(&_MSG.HTTPMethod));
      
   End-Evaluate;
   Return &returnMsg;
   
end-method;


method OnError
   /+ &pRequestMsg as Message +/
   /+ Returns String +/
   /+ Extends/implements PS_PT:Integration:IRequestHandler.OnError +/
   
   
   Local Message &returnMsg;
   Local Document &returnDoc;
   Local Compound &returnCom;
   Local Document &PODoc = &pRequestMsg.GetURIDocument();
   
   Local string &PO_id = &PODoc.GetElement("PO_ID").value;
   &returnMsg = CreateMessage(Operation.DCP_FS_PO_POST, %IntBroker_Fault);
   &returnDoc = &returnMsg.GetDocument();
   &returnCom = &returnDoc.DocumentElement;
   &returnCom.GetPropertyByName("PO_ID").value = &PO_id;
   &returnCom.GetPropertyByName("errorMsg").value = &pRequestMsg.IBException.ToString();
   rem Return &returnDoc.GenXmlString();
   Return &returnDoc.GenJsonString();
   

end-method;

Link the service operation Handler to the class

Setup Security

• In the previous example the data was passed in the URL.
• This only passes one row of data.
• What if you need to pass multiple rows?
• This can be done by passing JSON in the body of the message.
• Setup the URL with a ? But no parameters

Setup Request Message (Document)

Note Element Name (Compound peer under collection peer)

Get json string from the content

  Local string &jsonString = &requestMsg.GetContentString();

GenJsonString didn’t work well. It returned garbage and was inconsistent.

   &requestDoc = &requestMsg.GetDocument();

   &requestCom = &requestDoc.DocumentElement;

    Local string &jsonString = &requestDoc.GenJsonString();

JSON Body POSTMAN test