Pauses the target date of a case.
Namespace
goss.CaseManagement.v1.api.case.caseTargetDate.caseTargetDatePause
Worker
serverlibrary
Parameters
| Required Properties | Type | Description |
|---|---|---|
| caseBusinessKey | String <businessKey> | The business key of the case |
| user | Object | Details of the user |
| user.siteUserName | String | The username of a valid case manager |
| Optional Properties | Type | Description |
| note | String | A note to record against the case |
| private | Boolean | Whether the note is private. Defaults to true |
| proxyUser | Object | Details of a user acting on behalf of the user |
| proxyUser.siteUserName | String | The username of the proxy user |
{
"caseBusinessKey": "0123-4567-8901-2345",
"note": "Abc",
"private": true,
"user": {
"siteUserName": "Abc"
},
"proxyUser": {
"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 |
| 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 pause the target date |
Behaviour
If the validation rules pass
- Pauses the target date of the case
- If a note is provided, it is recorded against the case. The note is private unless private is set to false
Last modified on 23 October 2026
