LinkedIn
Copied!

Calling sequences for DX API endpoints

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 example illustrates 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
List of available case types in an Angular-based application
Calling sequence for retrieving case types
Calling sequence for retrieving case types

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
Work queues and a worklist 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 example illustrates 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
Case processing in an Angular-based application
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
Calling sequence for creating a case and skipping the Create view

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
Calling sequence for creating a case and including the Create view

Submitting assignments

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

Calling sequence for submitting assignments
Calling sequence for submitting assignments
Suggest Edit
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.