change_to_stage
Navigate to any valid stage within a case workflow by specifying the stageID. Handles case transitions, supports cleanup of processes, and ensures integrity with optimistic locking via eTag.
Instructions
Change to a specified stage of a case based on stageID passed. Allows navigation to any valid stage (primary, alternate) within a case workflow.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| caseID | Yes | Full case handle (e.g., "MYORG-SERVICES-WORK S-293001"). Must be a complete case identifier including spaces and special characters. | |
| cleanupProcesses | No | Whether to clean up the processes, including assignments, of the stage being switched away from. Default is true. Set to false to opt out of this cleanup feature. | |
| eTag | Yes | eTag unique value representing the most recent save date time (pxSaveDateTime) of the case. Required for optimistic locking to prevent concurrent modifications. Obtained from previous case operations. | |
| stageID | Yes | Stage ID to navigate to (e.g., "PRIM1", "ALT1"). Must be a valid stage identifier for the case type. | |
| viewType | No | Type of view data to return. "none" returns no UI resources (default), "form" returns form UI metadata in read-only review mode, "page" returns full page UI metadata in read-only review mode. | none |
Input Schema (JSON Schema)
{
"properties": {
"caseID": {
"description": "Full case handle (e.g., \"MYORG-SERVICES-WORK S-293001\"). Must be a complete case identifier including spaces and special characters.",
"type": "string"
},
"cleanupProcesses": {
"default": true,
"description": "Whether to clean up the processes, including assignments, of the stage being switched away from. Default is true. Set to false to opt out of this cleanup feature.",
"type": "boolean"
},
"eTag": {
"description": "eTag unique value representing the most recent save date time (pxSaveDateTime) of the case. Required for optimistic locking to prevent concurrent modifications. Obtained from previous case operations.",
"type": "string"
},
"stageID": {
"description": "Stage ID to navigate to (e.g., \"PRIM1\", \"ALT1\"). Must be a valid stage identifier for the case type.",
"type": "string"
},
"viewType": {
"default": "none",
"description": "Type of view data to return. \"none\" returns no UI resources (default), \"form\" returns form UI metadata in read-only review mode, \"page\" returns full page UI metadata in read-only review mode.",
"enum": [
"none",
"form",
"page"
],
"type": "string"
}
},
"required": [
"caseID",
"stageID",
"eTag"
],
"type": "object"
}