get_participant_role_details
Retrieve detailed metadata about a specific participant role in a Pega case, including role configuration, permissions, user details, and optional UI resources for enhanced case management.
Instructions
Get detailed information about a specific participant role in a Pega case, including role configuration, permissions, and user details. Returns participant role metadata with optional UI resources.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| caseID | Yes | Full case handle (case ID) to retrieve participant role details from. Example: "ON6E5R-DIYRecipe-Work-RecipeCollection R-1008". Must be a complete case identifier including spaces and special characters. | |
| participantRoleID | Yes | Participant role ID to get details for. This identifies the specific role within the case that you want detailed information about. | |
| viewType | No | Type of view data to return. "form" returns form UI metadata in uiResources object, "none" returns no UI resources. Default: "form". | form |
Input Schema (JSON Schema)
{
"properties": {
"caseID": {
"description": "Full case handle (case ID) to retrieve participant role details from. Example: \"ON6E5R-DIYRecipe-Work-RecipeCollection R-1008\". Must be a complete case identifier including spaces and special characters.",
"type": "string"
},
"participantRoleID": {
"description": "Participant role ID to get details for. This identifies the specific role within the case that you want detailed information about.",
"type": "string"
},
"viewType": {
"default": "form",
"description": "Type of view data to return. \"form\" returns form UI metadata in uiResources object, \"none\" returns no UI resources. Default: \"form\".",
"enum": [
"form",
"none"
],
"type": "string"
}
},
"required": [
"caseID",
"participantRoleID"
],
"type": "object"
}