recalculate_case_action_fields
Recalculates specific fields and when conditions on a case action form based on user input and form state. Validates case and action IDs, processes calculations, and returns updated field values and states while supporting content updates and page instructions.
Instructions
Recalculate calculated fields & whens for the current case action form. Executes field calculations and when conditions based on current form state and user input. Supports recalculating specific fields and when conditions, merging content updates, and applying page instructions during the calculation process. The API validates case and action IDs, processes calculation requests, and returns updated field values and states.
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 field calculations are defined. Example: "pyUpdateCaseDetails", "CompleteReview", "Approve". | |
calculations | Yes | Required object containing fields and when conditions to recalculate. Must contain at least one of fields or whens arrays. | |
caseID | Yes | Full case handle (case ID) to perform field recalculation 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 | Optional map of scalar properties and embedded page properties to be merged into the case during the recalculation process. Field values provided here will be available for use in calculations. Only fields that are present in the case action's view can be effectively utilized in calculations. | |
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. | |
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 | Optional list of page-related operations to be performed on embedded pages, page lists, or page group properties before recalculation. These operations allow manipulation of complex data structures that may affect calculation results. Each instruction specifies the operation type and target page structure. |