Testing Peoplesoft REST APIs for 3rd-Party Integration

 In this demo we will show how easy it is to deploy and test REST API provided in Peoplesoft for third-party.

As a pre-requisite:

1. The Deployment package is imported in Peoplesoft instance.
2. The required security is enabled.
3. The firewall requests are complete.

We will be working on Checklist Table Set up which is used in Campus Solutions module of Peoplesoft. The navigation to the page is:

Set Up SACR –> Common Definitions –> Checklists –> Checklist Table

 

The three tables being updated on this page are:

PS_CS_CHKLST_TBL

PS_CS_CHKLST_ITEM

PS_SCC_CKLSITM_STA

These have parent-child relationships based on the keys as shown:

Here is how the sample data looks in database tables.

Select * from PS_CS_CHKLST_TBL   where INSTITUTION = ‘MODEL’ and CHECKLIST_CD like ‘GFAID0%’;

Select * from PS_CS_CHKLST_ITEM  where INSTITUTION = ‘MODEL’ and CHECKLIST_CD like ‘GFAID0%’;

Select * from PS_SCC_CKLSITM_STA where INSTITUTION = ‘MODEL’ and CHECKLIST_CD like ‘GFAID0%’;

We will now demonstrate the four REST API’s working real time. These Peoplesoft provided REST services will integrate any 3^rd-party software that supports REST services. For this demo, we will use in POSTMAN testing tool.

The four REST API’s are:

1. GET – It retrieves data from Peoplesoft and shows as response. It is equivalent to SELECT SQL statement.
2. POST – It adds data to Peoplesoft. It is equivalent to INSERT SQL statement.
3. PUT – It modifies existing data in Peoplesoft. It is equivalent to UPDATE SQL statement.
4. DELETE – It deletes existing data in Peoplesoft. As the name suggests, it is equivalent to DELETE SQL statement.

 

GET (Select)

The GET API retrieves data from Peoplesoft and shows as response. It will retrieve existing data for INSTITUTION = ‘MODEL’ and CHECKLIST_CD = ‘GFAID0’.

We run the URL in POSTMAN.

The data in response matches the data in Peoplesoft.

Let us display the data from database again.

select * from PS_CS_CHKLST_TBL   where INSTITUTION = ‘MODEL’ and CHECKLIST_CD like ‘GFAID0%’;

select * from PS_CS_CHKLST_ITEM  where INSTITUTION = ‘MODEL’ and CHECKLIST_CD like ‘GFAID0%’;

select * from PS_SCC_CKLSITM_STA where INSTITUTION = ‘MODEL’ and CHECKLIST_CD like ‘GFAID0%’;

POST (insert)

The POST API will add data to Peoplesoft. It will insert data for INSTITUTION = ‘MODEL’ and CHECKLIST_CD = ‘GFAID2’. The response window will show success or error.

We paste the URL in POSTMAN and paste the JSON Formatted Data in Body.

The response is shown below.

The data is added in Peoplesoft.

The following SQLs show the data in database.

select * from PS_CS_CHKLST_TBL   where INSTITUTION = ‘MODEL’ and CHECKLIST_CD like ‘GFAID2%’;

select * from PS_CS_CHKLST_ITEM  where INSTITUTION = ‘MODEL’ and CHECKLIST_CD like ‘GFAID2%’;

select * from PS_SCC_CKLSITM_STA where INSTITUTION = ‘MODEL’ and CHECKLIST_CD like ‘GFAID2%’;

PUT (Update)

The PUT API updates data in Peoplesoft. It will update data for INSTITUTION = ‘MODEL’ and CHECKLIST_CD = ‘GFAID2’. The response window will show success or error.

We will be updating the following data.

The DESCR will be updated from “California Financial Aid -Fall” to “CA Financial Aid -Fall”.

We paste the URL in POSTMAN and paste the JSON Formatted Data in Body.

The response is shown below.

The data updated is shown in Peoplesoft online.

The following SQLs show the data in database.

select * from PS_CS_CHKLST_TBL   where INSTITUTION = ‘MODEL’ and CHECKLIST_CD like ‘GFAID2%’;

select * from PS_CS_CHKLST_ITEM  where INSTITUTION = ‘MODEL’ and CHECKLIST_CD like ‘GFAID2%’;

select * from PS_SCC_CKLSITM_STA where INSTITUTION = ‘MODEL’ and CHECKLIST_CD like ‘GFAID2%’;

DELETE

The DELETE API deletes data from Peoplesoft. It will delete data for INSTITUTION = ‘MODEL’ and CHECKLIST_CD = ‘GFAID2’. The response window will show success or error.

We are going to delete the data we updated with PUT earlier.

We paste the URL in POSTMAN.

No Data in Body as it is provided in the URL.

The response is shown below.

The data is gone from Peoplesoft online.

Following SQLs show that the data is not in database.

select * from PS_CS_CHKLST_TBL   where INSTITUTION = ‘MODEL’ and CHECKLIST_CD like ‘GFAID2%’;

select * from PS_CS_CHKLST_ITEM  where INSTITUTION = ‘MODEL’ and CHECKLIST_CD like ‘GFAID2%’;

select * from PS_SCC_CKLSITM_STA where INSTITUTION = ‘MODEL’ and CHECKLIST_CD like ‘GFAID2%’;