Skip to main content

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

DX API Version 1

Updated on August 5, 2022

DX API Version 1 focuses on section-based authoring. Learn how to access, use, and successfully implement DX APIs in your application.

DX APIs provide UI metadata that helps you develop a seamless user experience within your chosen front-end framework, while using the power of Pega’s case management capability. The difference between a DX API and a traditional API is that the case or assignment UX information in the DX API’s response includes information on UI elements, layout, actions, and styling.

DX API Version 1 expands on the mashup experience by integrating Pega-based processes into existing channels, with complete control over how the external site renders the experience.

Sample DX API v1 endpoints in Pega Platform

Supported UI capabilities

DX API supports a growing number of UI components. Depending on your version of Pega Platform, the support may vary.

Note: Upgrade to the latest version to use the capabilities of DX API to its complete extent.

In general, DX API Version 1 supports all UI capabilities that are also supported by DX API starter packs. However, the exact support depends on the version of Pega Infinity™.

For a complete list of features supported by DX Starter Packs, see Features supported by the DX Starter Packs.

Learn about DX API v1 in the following articles:

  • Accessing and testing Pega DX API Version 1

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

  • Using DX API v1 for case processing

    Take advantage of the case management capability in your custom application through the use of DX API endpoints. You can implement case processing in your application to drive assignments to completion, approve requests, or resolve expense reports. DX API helps you achieve that within the familiar environment of your custom front end.

  • DX API request and response elements

    You can build a user interface that combines the resources of Pega Platform with an environment that is well-known to users by implementing Pega digital experience (DX) REST API. To fully take advantage of Pega DX API endpoints, understand their request and response elements.

  • DX API compliance guidelines

    Ensure that your application is DX API-compliant, by learning about the appropriate design criteria.

  • Layouts in DX API

    Understand how you can organize your custom user interface with REST API by learning how layouts are supported in V1 Pega DX API.

  • Implementation of controls in DX API

    DX API v1 supports a range of controls. Learn about the structure of the controls to successfully implement them in your application.

  • Implementation of actions in DX API

    DX API v1 supports several actions. Learn about the structure of the actions to successfully implement them in your application.

  • Security Settings for DX API

    Secure access to your DX API endpoints by learning about authentication settings and access role privileges.

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