Updates a case stage.
Namespace
goss.CaseManagement.v1.api.case.caseStageUpdate
Worker
serverlibrary
Parameters
| Required Properties | Type | Description |
|---|---|---|
| caseBusinessKey | String <businessKey> | The business key of the case |
| caseStage | Object | Details of the new stage |
| caseStage.caseStageCode | String | The new stage. This much match one of the configured stages |
| caseStage.caseStageNotes | String | A private note that will be added to the case history |
| user | Object | Details of the user |
| user.siteUserName | String | The username of a valid case manager |
| Optional Properties | Type | Description |
| n/a | n/a | n/a |
{
"caseStage": {
"caseStageCode": "Abc",
"caseStageNotes": "Abc"
},
"caseBusinessKey": "Abc",
"user": {
"siteUserName": "Abc"
}
}
Rules
| Rule | Validation error |
|---|---|
| User must exist | Could not retrieve siteUser details |
| Case must exist | Could not retrieve case Case 1234-5678-9012-3456 |
| Case must be active | User aUser does not have permissions to change the case stage |
| User must be a member of the case managers group or the case manager if one is assigned | User aUser does not have permissions to change the case stage |
| A valid stage code must be supplied | The Stage: {newStage} does not exist on caseType: mycasetype |
| The case must not be at the supplied stage | The case stage is already {newStage} |
Behaviour
If the validation rules pass
- Updates the case to the new stage
- If a routine for the change to the new stage is defined in the case type this behaviour will be triggered
- A system note will be recorded to case history documenting the change
- Case reporting data will be updated with the new stage information
Last modified on 11 September 2026
