Skip to main content

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

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

Updated on May 3, 2021

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 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.

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.

  • Previous topic Configure data source simulations from Integration Designer (8.3)
  • Next topic Configure and debug automations using categories (8.3)

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