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 1

Updated on February 7, 2022

Familiarize yourself with Pega DX API 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.

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 navigation pane of App Studio, click Channels menu.

  2. In the Current channel interfaces section, click the API tile.

  3. On the API: Pega API page, in the Service package list, select V1 Pega API.

  4. Expand the Application category.

  5. Click the endpoint that you want to test.

    Result: The details of the endpoint appear, including a description, parameters, and sample responses.
  6. Test the endpoint:

    1. If the endpoint requires additional parameters, enter the information in the required fields.

    2. Click Try it out!.

    For example: If you want to test the GET /assignments/{ID} endpoint, which retrieves the details of a specific assignment, enter the assignment ID, and then click Try it out!.
    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