Converts a case to a different case type.
Namespace
goss.CaseManagement.v1.api.case.caseConvert
Worker
serverlibrary
Parameters
| Required Properties | Type | Description |
|---|---|---|
| caseBusinessKey | String | The business key of the case |
| caseConvert | Object | Details of the conversion |
| caseConvert.newCaseType | String | The name of the case type to convert the case to |
| caseConvert.keepManagingCase | Boolean | Whether the user keeps managing the case after it has been converted |
| user | Object | Details of the user |
| user.siteUserName | String | The username of a valid case manager |
| Optional Properties | Type | Description |
| caseConvert.conversionReason | String | The reason for the conversion |
{
"caseBusinessKey": "0123-4567-8901-2345",
"caseConvert": {
"newCaseType": "Abc",
"keepManagingCase": true,
"conversionReason": "Abc"
},
"user": {
"siteUserName": "Abc"
}
}
Returns
| Property | Type | Description |
|---|---|---|
| success | Boolean | Whether the request completed successfully |
| errors | Array | Any errors that occurred. Only returned if there are errors |
| warnings | Array | Any warnings that occurred. Only returned if there are warnings |
Rules
| Rule | Validation error |
|---|---|
| User must exist | Could not retrieve siteUser details |
| Case must exist | Could not retrieve case Case 1234-5678-9012-3456 |
| 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 convert the case |
Behaviour
If the validation rules pass
- Converts the case to the new case type
- If a conversion reason is provided, it is recorded against the case
Last modified on 23 October 2026
