Adds a note to a case. Notes can be added to open and closed cases.
Namespace
goss.CaseManagement.v1.api.notes.addNoteToCase
Worker
serverlibrary
Parameters
| Required Properties | Type | Description |
|---|---|---|
| caseReference | String <businessKey> | The business key of the case |
| note | String | The note you'd like to add |
| userName | String | This user will be recorded as the user adding the note. You must make sure the user exists and has permission to add a note to the case |
| Optional Properties | Type | Description |
| name | String | The display name of the user logging the note |
| private | Boolean | Default: false. Set true to log a private note (only visible to case managers) |
| userRole | String | The role of the user logging the note (eg "staff" or "citizen") |
Example
See Case Management API for a full example call.
{
"note": "A test note from a member of staff",
"private": true,
"caseReference": "9473-1891-4484-7268",
"name": "Test User",
"userRole": "staff",
"userName": "cmdemomanager"
}
Responses
Success
{
"id": 123,
"result": {
"success": true
},
"jsonrpc": "2.0"
}
Error
{
"id": 117,
"result": {
"success": false,
"errors": ["Could not load case reference - 9473-1891-4484-7268"]
},
"jsonrpc": "2.0"
}
Last modified on September 01, 2022
Share this page
