Skip to main content


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

Page-related operation queuing with page instructions

Updated on August 5, 2022

Pega APIs provide page instructions that you can use to make your application queue a list of page-related operations and send them to the server after the user performs a submit or a refresh. The server then runs the user operations in the order in which they were received.

For example, if the user edited a row, appended a row, and inserted a row, your application passes only the instructions and fields for those three rows to the server, instead of the entire table.

The page instructions are provided in the following APIs:

  • PUT /casetypes/{ID}/refresh
  • POST /cases
  • PUT /cases/{ID}
  • PUT /cases/{ID}/actions/{actionID}/refresh
  • POST /assignments/{ID}
  • PUT /assignments/{ID}/actions/{actionID}/refresh
Note: If a page instruction is invalid, for example, if the listIndex that was specified for a page list does not exist, the API returns an HTTP 400 error in the response body. To view the debugging information, you can change the value of the DebugPegaAPI dynamic system setting to True. For more information, see Editing a dynamic system setting and Debugging DX API.
  • Page instructions for embedded pages

    You can use page instructions to specify whether an embedded page within the post data should be updated, replaced, or removed from your case.

  • Page instructions for page groups

    You can use page instructions to specify whether an embedded page in a page group within the post data is to be updated, replaced, added to, or removed from your case.

  • Page instructions for page lists

    You can use page instructions to specify whether an embedded page in a page list within the post data is to be updated, replaced, appended, inserted, moved, or deleted from your case.

  • Updates to page lists and page groups with newRow

    You can update the visible page list or page group without multiple trips to the server to insert or append multiple rows with the newRow object. You can either send a full page list or page group in content or by using pageInstructions.

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.

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

Close Deprecation Notice
Contact us