create_case_participant
Add a participant to a Pega case with specified role and access permissions. Input case ID, user details, and role ID to assign permissions and integrate into case access control.
Instructions
Create a new participant in a Pega case with specified role and participant information. Adds users to case access control with appropriate permissions and role assignments.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| caseID | Yes | Full case handle (case ID) to add participant to. Example: "ON6E5R-DIYRecipe-Work-RecipeCollection R-1008". Must be a complete case identifier including spaces and special characters. | |
| content | Yes | Participant information object containing user details such as name, email, phone, and other contact information. Structure matches Data-Party schema. | |
| eTag | Yes | Required eTag unique value for optimistic locking from a previous case or participant API call. Prevents concurrent modification conflicts. | |
| pageInstructions | No | Optional list of page-related operations for embedded pages, page lists, or page groups included in the participant creation view. | |
| participantRoleID | Yes | Role ID to assign to the participant. This determines the permissions and access level the participant will have for the case. | |
| viewType | No | Type of view data to return. "form" returns form UI metadata, "none" returns no UI resources (default: "form") | form |
Input Schema (JSON Schema)
{
"properties": {
"caseID": {
"description": "Full case handle (case ID) to add participant to. Example: \"ON6E5R-DIYRecipe-Work-RecipeCollection R-1008\". Must be a complete case identifier including spaces and special characters.",
"type": "string"
},
"content": {
"description": "Participant information object containing user details such as name, email, phone, and other contact information. Structure matches Data-Party schema.",
"properties": {
"pyEmail1": {
"description": "Email address of the participant",
"type": "string"
},
"pyFirstName": {
"description": "First name of the participant",
"type": "string"
},
"pyFullName": {
"description": "Full name of the participant",
"type": "string"
},
"pyLastName": {
"description": "Last name of the participant",
"type": "string"
},
"pyPhoneNumber": {
"description": "Phone number of the participant",
"type": "string"
},
"pyTitle": {
"description": "Title of the participant",
"type": "string"
},
"pyWorkPartyUri": {
"description": "Unique identifier for the participant",
"type": "string"
}
},
"type": "object"
},
"eTag": {
"description": "Required eTag unique value for optimistic locking from a previous case or participant API call. Prevents concurrent modification conflicts.",
"type": "string"
},
"pageInstructions": {
"description": "Optional list of page-related operations for embedded pages, page lists, or page groups included in the participant creation view.",
"items": {
"description": "Page operation object with instruction type and target",
"properties": {
"instruction": {
"description": "The type of page instruction to perform",
"type": "string"
},
"target": {
"description": "The target page or page list for the instruction",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"participantRoleID": {
"description": "Role ID to assign to the participant. This determines the permissions and access level the participant will have for the case.",
"type": "string"
},
"viewType": {
"default": "form",
"description": "Type of view data to return. \"form\" returns form UI metadata, \"none\" returns no UI resources (default: \"form\")",
"enum": [
"form",
"none"
],
"type": "string"
}
},
"required": [
"caseID",
"eTag",
"content",
"participantRoleID"
],
"type": "object"
}