save_assignment_action

Preserve in-progress form data in Pega assignments to prevent loss of changes. Supports Connector actions, screen flows, and approvals, ignoring required field validations. Retrieve saved data later for continued editing or execution.

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. 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
`actionID`	Yes	Name of the assignment action - ID of the flow action rule for which form data is being saved. This corresponds to the Flow Action rule configured in the Pega application where the save functionality is available. Example: "CompleteVerification", "CollectInformation".
`assignmentID`	Yes	Full handle of the assignment to save form data for. Format: ASSIGN-WORKLIST {caseID}!{processID}. Example: "ASSIGN-WORKLIST PBANK-LOAN-WORK V-76003!REVIEW_FLOW". This uniquely identifies the specific assignment instance where form data will be saved.
`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.
`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.
`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_assignment_action request for this assignment. Used for optimistic locking to prevent concurrent modification conflicts.
`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.
`pageInstructions`	No	Optional list of page-related operations to be performed on embedded pages, page lists, or page groups included in the assignment action's view during the save operation. These operations allow manipulation of complex data structures within the assignment. Each instruction specifies the operation type and target page structure.

Input Schema (JSON Schema)

{
  "properties": {
    "actionID": {
      "description": "Name of the assignment action - ID of the flow action rule for which form data is being saved. This corresponds to the Flow Action rule configured in the Pega application where the save functionality is available. Example: \"CompleteVerification\", \"CollectInformation\".",
      "type": "string"
    },
    "assignmentID": {
      "description": "Full handle of the assignment to save form data for. Format: ASSIGN-WORKLIST {caseID}!{processID}. Example: \"ASSIGN-WORKLIST PBANK-LOAN-WORK V-76003!REVIEW_FLOW\". This uniquely identifies the specific assignment instance where form data will be saved.",
      "type": "string"
    },
    "attachments": {
      "description": "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.",
      "items": {
        "description": "Attachment object with file details and metadata",
        "properties": {
          "fileContent": {
            "description": "Base64 encoded file content",
            "type": "string"
          },
          "fileName": {
            "description": "Name of the attachment file",
            "type": "string"
          },
          "mimeType": {
            "description": "MIME type of the attachment",
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "content": {
      "description": "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.",
      "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_assignment_action request for this assignment. 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 save 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 groups included in the assignment action's view during the save operation. These operations allow manipulation of complex data structures within the assignment. Each instruction specifies the operation type and target page structure.",
      "items": {
        "description": "Page operation object with instruction type and target",
        "properties": {
          "instruction": {
            "description": "The type of page instruction to perform",
            "type": "string"
          },
          "target": {
            "description": "The target page or page list for the instruction",
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "assignmentID",
    "actionID",
    "eTag"
  ],
  "type": "object"
}

Pega DX MCP Server