get_assignment

Retrieve assignment details, including instructions, actions, and UI metadata, by providing its ID. Supports form and page view types for Pega DX MCP Server integration.

Instructions

Get detailed information about a specific assignment by assignment ID, including instructions and available actions. If the case type uses pessimistic locking and the client uses Constellation, this request locks the case.

Input Schema

Name	Required	Description	Default
`assignmentID`	Yes	Full handle of an assignment. Example: ASSIGN-WORKLIST PBANK-LOAN-WORK V-76003!REVIEW_FLOW
`pageName`	No	If provided, returns view metadata for the pageName view (only used when viewType is "page")
`viewType`	No	Type of view data to return. "form" returns only assignment UI metadata in uiResources object, "page" returns full page (read-only review mode) UI metadata in uiResources object	page

Input Schema (JSON Schema)

{
  "properties": {
    "assignmentID": {
      "description": "Full handle of an assignment. Example: ASSIGN-WORKLIST PBANK-LOAN-WORK V-76003!REVIEW_FLOW",
      "type": "string"
    },
    "pageName": {
      "description": "If provided, returns view metadata for the pageName view (only used when viewType is \"page\")",
      "type": "string"
    },
    "viewType": {
      "default": "page",
      "description": "Type of view data to return. \"form\" returns only assignment UI metadata in uiResources object, \"page\" returns full page (read-only review mode) UI metadata in uiResources object",
      "enum": [
        "form",
        "page"
      ],
      "type": "string"
    }
  },
  "required": [
    "assignmentID"
  ],
  "type": "object"
}

Install Server

HTTP connection URL

Other Tools from Pega DX MCP Server

Related Tools

get_assignment_action
@marco-looy/pega-dx-mcp
jump_to_step
@marco-looy/pega-dx-mcp
get_case_stages
@marco-looy/pega-dx-mcp
perform_assignment_action
@marco-looy/pega-dx-mcp
get_case
@marco-looy/pega-dx-mcp
get_data_view_metadata
@marco-looy/pega-dx-mcp