Skip to main content
close Search
Close search


Accessing a Pega application using the Pega API

1 Task

10 mins

Visible to all users
Beginner Pega Platform 8.2 English


The IT department is adding the ability for users to work on an internal portal. They submitted a requirement to display open positions within TGB to portal users. You have been assigned to test the API calls to the HRApps application.

The following table provides the credentials you need to complete the exercise.

Role Operator ID Password
Senior System Architect SSA@TGB rules

Your assignment

This exercise does not describe how you build the external application. The goal is to demonstrate the HTTP query needed to access your Pega application and the resulting JSON response.

Use the Pega API landing page to query the data page D_PositionsList to return a list of all open positions.

The JSON response can be difficult to read. To help make it more readable, try downloading a JSON viewer plugin for your browser.

You must initiate your own Pega instance to complete this Challenge.

Initialization may take up to 5 minutes so please be patient.

Detailed Tasks

1 Access a Pega application using the Pega API

  1. From the Dev Studio header, click the Info icon to open the Resources menu.

  2. From the menu, select Pega API to open the Pega API landing page.

    Resource menu
    Pega APIs require TLS/SSL by default to enable secure access through Pega API services. The exercise environment disables TLS/SSL to eliminate the need to use the HTTPS protocol. TLS/SSL should be disabled only for non-production or training purposes.
  3. In the Application category, in the data section, click /data/{ID} to query a data page.

    Landing application
  4. In the Value field, enter D_PositionList to display a list of all open positions.
  5. Click Try it out! to retrieve the data from the data page.
  6. When prompted for credentials, enter the username ssa@tgb and password rules.
  7. Observe the resulting JSON response in the Response Body section of the landing page. Below "pxResults", three positions are displayed as available.

    Body results

If you are having problems with your training, contact Pega Academy technical support.

Thank you for your feedback.

100% found this content useful

Want to help us improve this content?

Suggest an edit

We'd prefer it if you saw us at our best.

Pega Academy has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice