refresh_case_action
Refresh case action forms with updated property values, execute Data Transforms, and manage table row operations in modals. Validates case and action IDs, retrieves view data, and returns impacted fields, supporting Pega Infinity '25 features.
Instructions
Refresh case action form data with updated values after property changes, execute Data Transforms, and handle table row operations in modals. Supports form refresh settings configured in Flow Action rules, generative AI form filling, and embedded list operations with comprehensive validation and preprocessing execution. The API validates case and action IDs, retrieves view data, and returns information about fields affected by the refresh action. Supports Pega Infinity '25 features including table row operations in modals.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| actionID | Yes | Name of the case action - ID of the flow action rule. This corresponds to the Flow Action rule configured in the Pega application where form refresh settings are defined. Example: "pyUpdateCaseDetails", "CompleteReview", "Approve". | |
| caseID | Yes | Full case handle (case ID) to perform refresh on. Format: {OrgID}-{AppName}-{CaseType} {CaseNumber}. Example: "ON6E5R-DIYRecipe-Work-RecipeCollection R-1008". Must be a complete case identifier including spaces and special characters. | |
| content | No | Map of scalar properties and embedded page properties to be merged into the case during the refresh operation. Field values provided here will overwrite any settings made from preprocessing Data Transforms. Only fields that are present in the case action's view and are editable can be effectively updated. Non-visible fields cannot be set and updates to them may be lost in subsequent operations. | |
| contextData | No | Boolean value to fetch contextData or full view response. When true, returns only context data for improved performance. When false or not provided, returns the full view response including UI metadata. Default: false. | |
| eTag | Yes | Required eTag unique value representing the most recent save date time (pxSaveDateTime) of the case. This must be equal to the eTag header from the response of the most recent case update request, or from a get_case_action request for this case action. Used for optimistic locking to prevent concurrent modification conflicts. | |
| fillFormWithAI | No | Boolean value indicating whether to fill form with sample values using generative AI. This parameter works in conjunction with the EnableGenerativeAI toggle. When EnableGenerativeAI is turned on and fillFormWithAI=true, the system will attempt to generate appropriate form values using AI. Default: false. | |
| interestPage | No | Target page specification for table row operations on embedded list properties. Example: ".OrderItems(1)" to target the first item in the OrderItems page list. This parameter is required when operation parameter is specified. Used with interestPageActionID to identify the specific embedded page and action for modal-based table operations. | |
| interestPageActionID | No | Action ID for the embedded list operation Action rule. Example: "EmbeddedAction". This specifies the Flow Action rule that defines the preprocessing, validation, and post-processing logic for the table row operation. Required when operation parameter is specified. Only fields present in this Action's view can be modified during pre/post-processing. | |
| operation | No | String value indicating table row operation type for embedded list properties using modals (Pega Infinity '25+ feature). "showRow" is used when a row is being added or edited in a modal, triggering preprocessing of the interestPageActionID Action. "submitRow" is used when a row is being submitted, triggering validation and post-processing of the interestPageActionID Action. Only supported for table row operations in modals. | |
| originChannel | No | Optional origin channel identifier for this service request. Indicates the source of the request for tracking and audit purposes. Examples: "Web", "Mobile", "WebChat". Default value is "Web" if not specified. | |
| pageInstructions | No | List of page-related operations to be performed on embedded pages, page lists, or page group properties included in the case action's view during the refresh. These operations allow manipulation of complex data structures within the case. Each instruction specifies the operation type and target page structure. Only pages included in the case action's view can be modified. | |
| refreshFor | No | Name of the property which, when changed, triggers refresh after executing the Data Transform configured under form refresh settings of the flow action. When provided, the corresponding Data Transform is executed to provide updated default values. Replaces the deprecated pyRefreshData Data Transform approach. Only change property events are supported in form refresh settings. |