refresh_case_action

Previous value: -"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\"."New value: +"Action ID for case/stage action (Example: \"pyUpdateCaseDetails\", \"pyApproval\"). CRITICAL: Action IDs are CASE-SENSITIVE and have no spaces even if display names do (\"Edit details\" → \"pyUpdateCaseDetails\"). Use get_case to find correct ID from availableActions array - use \"ID\" field not \"name\" field."

Previous value: -"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."New value: +"Case ID. Example: \"MYORG-APP-WORK C-1001\". Complete identifier including spaces."

Previous value: -"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."New value: +"Optional. Auto-fetched if omitted. For faster execution, use eTag from previous response."

Previous value: -"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."New value: +"Whether to fill form with AI-generated sample values. Requires EnableGenerativeAI toggle. Default: false"

Previous value: -"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."New value: +"Optional list of page-related operations for embedded pages, page lists, or page groups. Required for setting embedded page references."

Added value: +"Page operation for embedded pages. Use REPLACE instruction to set embedded page references with full object including pzInsKey. Example: {\"instruction\": \"REPLACE\", \"target\": \"PageName\", \"content\": {\"Property\": \"value\", \"pyID\": \"ID-123\", \"pzInsKey\": \"CLASS-NAME ID-123\"}}"

Added value: +{
+  "content": {
+    "description": "Content to set on the embedded page (required for UPDATE and REPLACE)",
+    "type": "object"
+  },
+  "instruction": {
+    "description": "Page instruction type. UPDATE (add fields to page), REPLACE (replace entire page), DELETE (remove page), APPEND (add item to page list), INSERT (insert item in page list), MOVE (reorder page list items)",
+    "enum": [
+      "UPDATE",
+      "REPLACE",
+      "DELETE",
+      "APPEND",
+      "INSERT",
+      "MOVE"
+    ],
+    "type": "string"
+  },
+  "target": {
+    "description": "Target embedded page name",
+    "type": "string"
+  }
+}

Added value: +[
+  "instruction",
+  "target"
+]

Previous value: -"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."New value: +"Property name that triggers refresh when changed. Executes Data Transform from form refresh settings."

Added value: +{
+  "description": "Optional session-specific credentials. If not provided, uses environment variables. Supports two authentication modes: (1) OAuth mode - provide baseUrl, clientId, and clientSecret, or (2) Token mode - provide baseUrl and accessToken.",
+  "properties": {
+    "accessToken": {
+      "description": "Direct access token (required for token mode)",
+      "type": "string"
+    },
+    "apiVersion": {
+      "default": "v2",
+      "description": "API version (optional, defaults to v2)",
+      "type": "string"
+    },
+    "baseUrl": {
+      "description": "Pega base URL (required if providing credentials)",
+      "type": "string"
+    },
+    "clientId": {
+      "description": "OAuth2 client ID (required for OAuth mode)",
+      "type": "string"
+    },
+    "clientSecret": {
+      "description": "OAuth2 client secret (required for OAuth mode)",
+      "type": "string"
+    },
+    "sessionId": {
+      "description": "Optional session ID. If not provided, a new session will be created.",
+      "type": "string"
+    },
+    "tokenExpiry": {
+      "description": "Token expiry in seconds from now (optional for token mode)",
+      "type": "number"
+    }
+  },
+  "type": "object"
+}

Previous value: -[
-  "caseID",
-  "actionID",
-  "eTag"
-]New value: +[
+  "caseID",
+  "actionID"
+]