Skip to main content


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

Calling sequences for DX API endpoints

Updated on August 5, 2022

DX API endpoints retrieve information from Pega Platform and deliver it into your custom application. For example, you can implement case processing in your non-Pega application by using endpoints to communicate with the source (make "calls") and fetch all the necessary data in the background. Learn about the sequences of DX API calls and responses to better understand how endpoints work.

Case types

The following examples illustrate how DX API populates a list of available case types in an external Angular-based web application:

List of available case types in an Angular-based application
Calling sequence for retrieving case types
A calling sequence for retrieving case types between a custom web application and Pega Platform.

Worklists

The following example illustrates how DX API populates a worklist and retrieves work queues from Pega Platform for the external application:

Work queues and a worklist in an Angular-based application
Available work queues and a retrieved worklist with two items in an Angular-based application

In this scenario, an operator might want to access a list of work items in the default work queues. The following endpoints call Pega Platform:

  • GET /data/D_OperatorID retrieves a list of work queues that are configured for the operator.
  • GET /data/D_Worklist retrieves the worklist for the operator.
  • GET /data/D_WorkBasket retrieves the work items in the work queues.

Case creation (skipping the Create view)

The following examples illustrate how DX API recreates case processing in the external application. In this scenario, the user skips the Create view:

Case processing in an Angular-based application
A sample case form with customer details in an Angular-based application
Note: The GET /cases/{ID}/views/pyCaseDetails endpoint displays the details of the case. If you only need to display assignment action details, you can skip that endpoint.
Calling sequence for creating a case and skipping the Create view
A calling sequence for creating a case and skipping the Create view between a custom web application and Pega Platform.

Case creation (including the Create view)

The following example illustrates how DX API recreates case processing in the external application. In this scenario, the user populates the Create view when they create a new case:

Calling sequence for creating a case and including the Create view
A calling sequence for creating a case and including the Create view between a custom web application and Pega Platform.

Submitting assignments

The following example illustrates how DX API handles submitting assignments in the external application:

Calling sequence for submitting assignments
A calling sequence for submitting assignments between a custom web application and Pega Platform.

Tags

Pega Platform 8.7 DX API

Have a question? Get answers now.

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

Visit the Support Center

Did you find this content helpful?

Yes
No

Want to help us improve this content?
Suggest an edit

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us