Skip to main content

Accessing a Pega application using the Pega API

1 Task

10 mins

Visible to: All users
Intermediate Pega Platform 8.7 Data Integration English
Verify the version tags to ensure you are consuming the intended content or, complete the latest version.


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.

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

Note: 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.

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

Role User name Password
Senior System Architect SSA@TGB pega123!
Note: Your practice environment may support the completion of multiple challenges. As a result, the configuration shown in the challenge walkthrough may not match your environment exactly.

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

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

Challenge Walkthrough

Detailed Tasks

1 Access a Pega application using the Pega API

  1. In App Studio, click Channels > API to open the Pega API landing page.
    Channels > API
    Note: 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.
  2. In the Application category, in the data section, to the right of /data/{ID}, click Get data view contents to query a data page.
    Pega API
  3. In the Value field, enter D_PositionList to display a list of all open positions.
  4. Click Try it out! to retrieve the data from the data page.
  5. If you are prompted to enter your credentials, enter the challenge credentials.
  6. Observe the resulting JSON response in the Response Body section of the landing page. Below "pxResults", the positions are displayed as available.
    Body results
Note: The JSON response can be difficult to read. To help make it more readable, try downloading a JSON viewer plugin for your browser. 

This Challenge is to practice what you learned in the following Module:

Available in the following mission:

If you are having problems with your training, please review the Pega Academy Support FAQs.

Did you find this content helpful?

Want to help us improve this content?

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