recalculate_case_action_fields

Recalculates fields and when conditions in Pega case action forms. Updates field values based on user inputs, merges content changes, and applies page instructions. Validates case IDs and action IDs to ensure accurate calculations.

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

Input Schema (JSON Schema)

{
  "properties": {
    "actionID": {
      "description": "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\".",
      "type": "string"
    },
    "calculations": {
      "additionalProperties": false,
      "description": "Required object containing fields and when conditions to recalculate. Must contain at least one of fields or whens arrays.",
      "properties": {
        "fields": {
          "description": "Array of field objects to recalculate. Each field object must contain name and context properties.",
          "items": {
            "additionalProperties": false,
            "properties": {
              "context": {
                "description": "Context or page reference for the field calculation. Specifies the data context in which the field calculation should be performed.",
                "type": "string"
              },
              "name": {
                "description": "Name of the field to recalculate. Must be a valid property reference within the case action view.",
                "type": "string"
              }
            },
            "required": [
              "name",
              "context"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "whens": {
          "description": "Array of when condition objects to recalculate. Each when object must contain name and context properties.",
          "items": {
            "additionalProperties": false,
            "properties": {
              "context": {
                "description": "Context or page reference for the when condition evaluation. Specifies the data context in which the when condition should be evaluated.",
                "type": "string"
              },
              "name": {
                "description": "Name of the when condition to recalculate. Must be a valid when rule reference accessible within the case action context.",
                "type": "string"
              }
            },
            "required": [
              "name",
              "context"
            ],
            "type": "object"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "caseID": {
      "description": "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.",
      "type": "string"
    },
    "content": {
      "description": "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.",
      "type": "object"
    },
    "eTag": {
      "description": "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.",
      "type": "string"
    },
    "originChannel": {
      "description": "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.",
      "type": "string"
    },
    "pageInstructions": {
      "description": "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.",
      "items": {
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "caseID",
    "actionID",
    "eTag",
    "calculations"
  ],
  "type": "object"
}

Pega DX MCP Server