get_assignment_action

Retrieve detailed information about a specific action on an assignment in Pega, including UI metadata and preprocessing execution. Supports retrieving form or page views and optionally excludes additional actions for optimized performance.

Instructions

Get detailed information about a specific action that can be performed on an assignment. Retrieves assignment action defined for an assignment step in a case process, including UI metadata and preprocessing execution. If the case type uses pessimistic locking and the client uses Constellation, this request may lock the case.

Input Schema

Name	Required	Description	Default
`actionID`	Yes	Name of the action to be retrieved - ID of the flow action rule. Example: Verify, Approve, Reject
`assignmentID`	Yes	Full handle of the assignment. Example: ASSIGN-WORKLIST O1UGTM-TESTAPP13-WORK T-36004!APPROVAL_FLOW
`excludeAdditionalActions`	No	When true, excludes information on all actions performable on the case. Set to true if action information was already retrieved in a previous call. When false, response includes data.caseInfo.availableActions and data.caseInfo.assignments.actions fields
`viewType`	No	Type of view data to return. "form" returns the form UI metadata (in read-only review mode, without page-specific metadata), "page" returns the full page (in read-only review mode) UI metadata in the uiResources object	page

Input Schema (JSON Schema)

{
  "properties": {
    "actionID": {
      "description": "Name of the action to be retrieved - ID of the flow action rule. Example: Verify, Approve, Reject",
      "type": "string"
    },
    "assignmentID": {
      "description": "Full handle of the assignment. Example: ASSIGN-WORKLIST O1UGTM-TESTAPP13-WORK T-36004!APPROVAL_FLOW",
      "type": "string"
    },
    "excludeAdditionalActions": {
      "default": false,
      "description": "When true, excludes information on all actions performable on the case. Set to true if action information was already retrieved in a previous call. When false, response includes data.caseInfo.availableActions and data.caseInfo.assignments.actions fields",
      "type": "boolean"
    },
    "viewType": {
      "default": "page",
      "description": "Type of view data to return. \"form\" returns the form UI metadata (in read-only review mode, without page-specific metadata), \"page\" returns the full page (in read-only review mode) UI metadata in the uiResources object",
      "enum": [
        "form",
        "page"
      ],
      "type": "string"
    }
  },
  "required": [
    "assignmentID",
    "actionID"
  ],
  "type": "object"
}

Pega DX MCP Server