save_assignment_action
Save assignment form data for later use without executing the action, preserving in-progress changes for continued editing when the assignment is reopened.
Instructions
Save assignment action form data without executing the action. Implements "Save for later" functionality that preserves form data in progress so changes will not be lost when returned to the assignment. If no eTag is provided, automatically fetches the latest eTag from the assignment for seamless operation. Available for Connector actions like Collect info steps, screen flow assignments and customized approval steps. Required field validations are ignored - only server-side validations (dictionary validations) are performed. The saved form data can be retrieved later when the assignment is reopened for continued editing or action execution.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| assignmentID | Yes | Assignment ID. Format: ASSIGN-WORKLIST {caseID}!{processID}. Example: "ASSIGN-WORKLIST MYORG-APP-WORK C-1001!PROCESS""ASSIGN-WORKLIST PBANK-LOAN-WORK V-76003!REVIEW_FLOW". This uniquely identifies the specific assignment instance where form data will be saved. | |
| actionID | Yes | Action ID from assignment (Example: "pyApproval", "Submit"). CRITICAL: Action IDs are CASE-SENSITIVE and have no spaces even if display names do ("Complete Review" → "CompleteReview"). Use get_assignment to find correct ID from actions array - use "ID" field not "name" field. | |
| eTag | No | Optional. Auto-fetched if omitted. For faster execution, use eTag from previous response. | |
| content | No | Optional map of scalar properties and embedded page properties containing form data to be saved. Only fields that are part of the assignment action's view can be saved. Field names should match the property names defined in the Pega application. Example: {"CustomerName": "John Doe", "RequestAmount": 5000, "Comments": "Initial request details"}. This data will be preserved and available when the assignment is reopened. | |
| pageInstructions | No | Optional list of page-related operations for embedded pages, page lists, or page groups. Required for setting embedded page references. Only pages included in the assignment action's view can be modified. | |
| attachments | No | Optional list of attachments to be added to specific attachment fields included in the assignment action's view during the save operation. Each attachment entry specifies the attachment details and target field. Only attachment fields included in the assignment action's view can be modified during save. | |
| originChannel | No | Optional origin channel identifier for this service request. Indicates the source of the save request for tracking and audit purposes. Examples: "Web", "Mobile", "WebChat". Default value is "Web" if not specified. | |
| sessionCredentials | No | 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. |