Accessing and testing DX API

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

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. By generating a sample response, you can better understand how the endpoint works and what types of responses to expect.

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

    A list of DX API endpoints appears.

    DX API endpoints
    "List of DX API endpoints in App Studio"
    DX API endpoints

    The list is divided into further categories, for example, attachments, case types, assignments, and so on.

  5. Click the endpoint that you want to test.

    The details of the endpoint appear, including a description, parameters, and sample responses.  

  6. Test the endpoint by providing the required information and clicking the Try it out! button.

    For example, to test an endpoint that displays a list of attachments for a specific case, expand the GET /cases/{caseID}/attachments endpoint, and then, in the Parameters section, in the caseID field, enter the ID of a case to include in the test. Then, click the Try it out! button. As a result, the system generates a response to the simulated query, as in the following example:

Sample JSON response
Sample JSON response
Did you find this content helpful?

100% found this useful

Have a question? Get answers now.

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