add_optional_process
Initiate and manage optional actions in Pega DX by adding stage or case-wide processes. Specify case ID, process ID, and view type to return next assignment details for streamlined case handling.
Instructions
Add stage or case-wide optional process and return details of the next assignment in the process. The API is invoked when a user tries to initiate an optional action listed under case actions which are configured and designed as a process under case wide actions or stage-only actions.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| caseID | Yes | Full case handle (case ID) to add optional process to. Example: "MYORG-SERVICES-WORK S-293001". Must be a complete case identifier including spaces and special characters. | |
| processID | Yes | Process ID - Name of the process which is the ID of a flow rule. Example: "UpdateContactDetails". ProcessID can be retrieved with a lookup for ID attribute under availableProcesses node of a DX API response. | |
| viewType | No | Type of view data to return. "none" returns no uiResources, data.caseInfo.content contains the fields of the pyDetails view (default), "form" returns the form UI metadata (read-only review mode, without page-specific metadata) in the uiResources object, "page" returns the full page (read-only review mode) UI metadata in the uiResources object. | none |
Input Schema (JSON Schema)
{
"properties": {
"caseID": {
"description": "Full case handle (case ID) to add optional process to. Example: \"MYORG-SERVICES-WORK S-293001\". Must be a complete case identifier including spaces and special characters.",
"type": "string"
},
"processID": {
"description": "Process ID - Name of the process which is the ID of a flow rule. Example: \"UpdateContactDetails\". ProcessID can be retrieved with a lookup for ID attribute under availableProcesses node of a DX API response.",
"type": "string"
},
"viewType": {
"default": "none",
"description": "Type of view data to return. \"none\" returns no uiResources, data.caseInfo.content contains the fields of the pyDetails view (default), \"form\" returns the form UI metadata (read-only review mode, without page-specific metadata) in the uiResources object, \"page\" returns the full page (read-only review mode) UI metadata in the uiResources object.",
"enum": [
"none",
"form",
"page"
],
"type": "string"
}
},
"required": [
"caseID",
"processID"
],
"type": "object"
}