Table of Contents

Specify a queue of user operations in Pega Digital Experience APIs (8.3)

You can now specify a queue of page instructions for user operations on embedded pages, page lists, and page groups in Pega Digital Experience APIs. The page instructions allow your client application to more accurately model users' actions.

Pega Digital Experience APIs support the following operations:

  • For embedded pages: DELETE, REPLACE, and UPDATE.
  • For page lists: DELETE, REPLACE, UPDATE, APPEND, INSERT, and MOVE.
  • For page groups: DELETE, REPLACE, UPDATE, and ADD.

Each time a user performs an operation, such as modifying a row in a table, the client application queues it. When the user completes the form, the client application passes all the operations via the page instructions to the server, and the server plays back the operations in the order that the user made them. For example, if the user edited a row (UPDATE), appended a row (APPEND), and inserted a row (INSERT), the client application passes only the instructions and fields for those three rows to the server instead of the entire table.

The following image shows the page instructions that are included in the Model Schema section of the POST /assignments{ID} Pega Digital Experience API.

Page instructions in the Model Schema section
Model Schema section with page instructions
Page instructions in the Model Schema section

The following Pega Digital Experience APIs include the page instructions:

  • PUT /casetypes/{ID}/refresh
  • POST /cases
  • PUT /cases/{ID}
  • PUT /cases/{ID}/actions/{actionID}/refresh
  • POST /assignments/{ID}
  • PUT /assignments/{ID}/actions/{actionID}/refresh

For more information, see Page-related operation queuing with page instructions in Pega APIs.

Suggest Edit

Have a question? Get answers now.

Visit the Pega Support Community to ask questions, engage in discussions, and help others.