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