Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Accessing and testing Pega DX API Version 2

Updated on August 5, 2022

Familiarize yourself with Pega DX API Version 2 (v2) and learn to use it successfully by exploring what you can achieve with individual endpoints.

By generating a sample response to a simulated endpoint call, you can better understand how the endpoint works and what types of responses to expect.
Before you begin: Create an OAuth 2.0 client registration data instance and save the credentials to be able to test individual endpoints. For more information, see Creating authorization for DX API tests.

Pega Platform provides categorized lists of all available API endpoints, which you can conveniently access and analyze. Each entry explains how a specific endpoint works and provides additional information, such as response data. You can also test every endpoint and simulate a response.

  1. In the header of Dev Studio, click the Resources menu icon, and then click Pega API.
  2. In the Pega API Help window, in the Service package list, select V2 DX API.
    Note: The Pega API Help window might appear as a new tab in your browser, depending on your setup.
  3. Click Authorize.
  4. In the Available autorizations window, in the Password (OAuth2, password) section, enter the required credentials:
    1. In the username: and password: fields, enter your Pega credentials.
    2. In the client_id: and client_secret: fields, enter the OAuth credentials that you saved in Creating authorization for DX API tests.
  5. Click Authorize, and then click Close.
    Result: You can now test the endpoints.
  6. Click the endpoint that you want to test.
    Result: The details of the endpoint appear, including a description, parameters, and sample responses.
  7. Test the endpoint:
    1. Click Try it out.
    2. If the endpoint requires additional parameters, enter the information in the required fields.
      For example: If you want to test the GET /cases/{caseID}/attachments endpoint, which retrieves the details of a list of attachments in a specific case, after you click Try it out, provide the case ID.
    3. Click Execute.
    Result: The system generates a response to the simulated query, as in the following example:
    Sample JSON response
    Sample DX API test response generated by the system

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us