Updates a case status.
Namespace
goss.CaseManagement.v1.api.case.caseStatusUpdate
Worker
serverlibrary
Parameters
| Required Properties | Type | Description |
|---|---|---|
| caseBusinessKey | String <businessKey> | The business key of the case |
| caseStatusCode | String | The new status. This much match one of the configured statuses |
| user | Object | Details of the user |
| user.siteUserName | String | The username of a valid case manager |
| Optional Properties | Type | Description |
| proxyUser | Object | Details of the proxy user |
| proxyUser.siteUserName | String | The username |
{
"caseBusinessKey": "Abc",
"caseStatusCode": "Abc",
"user": {
"siteUserName": "Abc"
},
"proxyUser": {
"siteUserName": "Abc"
}
}
Rules
| Rule | Validation error |
|---|---|
| User must exist | Could not retrieve siteUser details |
| Proxy user must exist | Could not retrieve proxyUser 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 status |
| 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 status |
| A valid status code must be supplied | The status: {newStatus} does not exist on caseType: mycasetype |
| The case must not be at the supplied status | The current case status: {newStatus} is already in the target status: {newStatus} |
Behaviour
If the validation rules pass
- Updates the case to the new status
- If the Status Updated email is enabled an email will be sent to the Case Owner informing them of the status change
- If a routine for the change to the new status 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 status information
Last modified on 11 September 2026
