perform_assignment_action
Execute actions on Pega assignments to update case data, progress workflows, and manage attachments. Supports local and connector actions, returns case details, and provides UI resources based on viewType.
Instructions
Perform an action on a Pega assignment, updating case data and progressing the workflow. Takes the assignment ID and action ID as path parameters, along with optional content, page instructions, and attachments. Requires an eTag value from a previous get_assignment_action call. The API handles pre-processing logic, merges request data into the case, performs the action, and validates the results. If the action is a local action, the API stays at the current assignment. If it's a connector action, the API moves to the next assignment or provides a confirmation note if the workflow is complete. Returns detailed case information, optional UI resources based on viewType parameter, and either next assignment information or a confirmation message.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| actionID | Yes | Name of the assignment action to perform - ID of the flow action rule to be executed on the assignment. This corresponds to a specific flow action configured in the Pega application. Example: "CompleteVerification", "Approve", "Reject". | |
| assignmentID | Yes | Full handle of the assignment to perform the action on. Format: ASSIGN-WORKLIST {caseID}!{processID}. Example: "ASSIGN-WORKLIST O1UGTM-TESTAPP13-WORK T-35005!APPROVAL_FLOW". This is the complete assignment identifier that uniquely identifies the specific assignment instance. | |
| attachments | No | Optional list of attachments to be added to or deleted from specific attachment fields included in the assignment action's view. Each attachment entry specifies the operation (add/delete) and attachment details. Only attachment fields included in the assignment action's view can be modified. | |
| content | No | Optional map of scalar and embedded page values to be set to the fields included in the assignment action's view. Only fields that are part of the submitted assignment action's view can be modified. Field names should match the property names defined in the Pega application. Example: {"EmployeeName": "Celine", "EmployeeAge": 55, "EmployeeStatus": "Active"}. Values will overwrite any settings made from pre-processing Data Transforms. | |
| 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 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. 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 assignment action's view can be modified. | |
| viewType | No | Type of UI resources to return in the response. "none" returns no UI resources (default), "form" returns form UI metadata in read-only review mode without page-specific metadata, "page" returns full page UI metadata in read-only review mode. Use "form" or "page" when you need UI structure information for displaying the results. | none |