I am sure you might have heard a lot about DX API and wanted to try out a DX API in real and understand more about these APIs. In this blog, we will tell few simple steps, following which you can execute any DX API see its output, this will also help you explore DX API on your own in future.
First question, do we need a local Pega setup up for that, or do we need to install Pega PE to try DX API. The answer is NO... Then where we should try ????
The answer is Pega cloud instance which you found in different Pega Courses like CSA, CSSA etc. Want to know about these Pega Cloud Instances, you need to go through my blog - https://www.techpapers.online/post/on-demand-pega-setup
Open Pega Cloud Instance and login.
Switch to App Studio.
Click on Channels on the left panel of the App Studio.
Click API, select version of DX API as V1. You will see a list of DX APIs in this page.
Let's take a very simple API to try out. this API returns the content of a Data Page. All you need to pass the name of Data Page an input parameter to this API. This API is listed under Data category. Click on Get Method of the first API as shown below.
Next you need to find a Data Page which does not take any parameter [ or take optional Parameter, this is to ensure you take simple use case for the first try. But you can very well take Data page which accepts mandatory parameter also]. You need to give name of data page as input Parameter for API and click try out button.
Just scroll down, you will see content of this Data Page under pxResults in JSON file.
Like wise you can try other APIs like GET-casetypes, GET-Applications etc. If you face any privilege issue while executing DX API, you can refer my blog - Pega DX API Authentication and Privilege (techpapers.online).
Still not able to call DX API, just put your question in comments section, our team will get back to you ASAP.
Environment this blog is based on
Pega Version - 8.6.6
Release - April 2023
Comments