Skip to main content


Page-related operation queuing with page instructions in Pega APIs

Suggest edit Updated on January 29, 2021

You can use the page instructions provided in Pega APIs so that your application queues a list of page-related operations and sends them to the server after the user performs a submit or refresh. The server then plays back the user operations in the order that 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 Pega 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

Understand how to use page instructions for each of the following:

Note: If a page instruction is invalid, for example, if the listIndex that was specified for a page list does not exist, the Pega 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.

Related Content


Pega API HTTP status codes and errors
Did you find this content helpful? YesNo

Have a question? Get answers now.

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

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

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