changedInput schema / properties / caseID / description
Previous value: -"Full case handle (case ID) to add participant to. 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.\"ON6E5R-DIYRecipe-Work-RecipeCollection R-1008\". a complete case identifier including spaces and special characters."
changedInput schema / properties / eTag / description
Previous value: -"Required eTag unique value for optimistic locking from a previous case or participant API call. Prevents concurrent modification conflicts."New value: +"Optional. Auto-fetched if omitted. For faster execution, use eTag from previous response."
changedInput schema / properties / pageInstructions / description
Previous value: -"Optional list of page-related operations for embedded pages, page lists, or page groups included in the participant creation view."New value: +"Optional list of page-related operations for embedded pages, page lists, or page groups. Required for setting embedded page references."
changedInput schema / properties / pageInstructions / items / description
Previous value: -"Page operation object with instruction type and target"New 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\"}}"
addedInput schema / properties / pageInstructions / items / properties / content
Added value: +{
+ "description": "Content to set on the embedded page (required for UPDATE and REPLACE)",
+ "type": "object"
+}
changedInput schema / properties / pageInstructions / items / properties / instruction / description
Previous value: -"The type of page instruction to perform"New value: +"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)"
addedInput schema / properties / pageInstructions / items / properties / instruction / enum
Added value: +[
+ "UPDATE",
+ "REPLACE",
+ "DELETE",
+ "APPEND",
+ "INSERT",
+ "MOVE"
+]
changedInput schema / properties / pageInstructions / items / properties / target / description
Previous value: -"The target page or page list for the instruction"New value: +"Target embedded page name"
addedInput schema / properties / pageInstructions / items / required
Added value: +[
+ "instruction",
+ "target"
+]
addedInput schema / properties / sessionCredentials
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"
+}
changedInput schema / properties / viewType / description
Previous value: -"Type of view data to return. \"form\" returns form UI metadata, \"none\" returns no UI resources (default: \"form\")"New value: +"UI resources to return. \"form\" returns form UI metadata, \"none\" returns no UI resources (default: \"form\")"
changedInput schema / required
Previous value: -[
- "caseID",
- "eTag",
- "content",
- "participantRoleID"
-]New value: +[
+ "caseID",
+ "content",
+ "participantRoleID"
+]